From 03284123454f04017e82ecb44f3ffcee67e7b10a Mon Sep 17 00:00:00 2001 From: Tim Steinbach Date: Thu, 10 May 2018 08:44:38 -0400 Subject: [PATCH] Usage in README --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 7734569..062f7bf 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,23 @@ [![Build Status](https://travis-ci.org/NeQuissimus/circe-kafka.svg?branch=master)](https://travis-ci.org/NeQuissimus/circe-kafka) Implicitly turn your `Encoder` and `Decoder` instances into `Serializer`, `Deserializer` and `Serde`. + +## Usage + +```scala +import io.circe.{ Decoder, Encoder } +import org.apache.kafka.common.serialization.{ Deserializer, Serde, Serializer } + +final case class Foo(i: Int) + +// + +import com.nequissimus.circe.kafka._ + +implicit val encoder: Encoder[Foo] = ... // for example by importing io.circe.generic.auto._ +implicit val decoder: Decoder[Foo] = ... + +val serializer: Serializer[Foo] = implicitly +val deserializer: Deserializer[Foo] = implicitly +val serde: Serde[Foo] = implicitly +```