Add circe integration documentation

commercetools · Apr 29, 2024 · 409fc9a · 409fc9a
1 parent fc0518e
commit 409fc9a
Showing 1 changed file with 9 additions and 0 deletions.
diff --git 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/