diff --git a/docs/integrations/circe.md b/docs/integrations/circe.md index 2b60567..5256a04 100644 --- a/docs/integrations/circe.md +++ b/docs/integrations/circe.md @@ -1 +1,10 @@ # Circe + +The `fs2-queues-circe` provides integration with the [circe][circe] library. + +It provides: + + - a @:api(com.commercetools.queue.Serializer) for each type `T` that has an implicit `io.circe.Encoder[T]` in scope. + - a @:api(com.commercetools.queue.Deserializer) for each type `T` that has an implicit `io.circe.Decoder[T]` in scope. + +[circe]: https://circe.github.io/circe/