From 7df1a267041a5d21271a8d4fd673ef30dc8e4aba Mon Sep 17 00:00:00 2001 From: David Geirola Date: Mon, 4 Nov 2024 10:58:45 +0100 Subject: [PATCH] Add docs (#1010) --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 134cc616..c3038142 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,17 @@ fs2-rabbit [![MergifyStatus](https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/profunktor/fs2-rabbit&style=flat)](https://mergify.io) [![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-brightgreen.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org) -Stream-based library for [RabbitMQ](https://www.rabbitmq.com/) built-in on top of [Fs2](http://fs2.io/) and the [RabbitMq Java Client](https://github.com/rabbitmq/rabbitmq-java-client). +Stream-based library for [RabbitMQ](https://www.rabbitmq.com/) built-in on top of [Fs2](http://fs2.io/) and +the [RabbitMq Java Client](https://github.com/rabbitmq/rabbitmq-java-client). ## Dependencies +> [!NOTE] +> - From `3.6.0` onwards, the library is published only for Scala `3.x` and `2.13.x` +> - For Scala `2.12.x` use the latest `<= 3.5.x` versions. +> - Previous artifacts `<= 2.0.0-RC1` were published using the `com.github.gvolpe` group id (see [migration + guide](https://github.com/profunktor/fs2-rabbit/wiki/Migration-guide-(Vim))) + Add this to your build.sbt: ```scala @@ -23,9 +30,6 @@ And this one if you would like to have Json support: libraryDependencies += "dev.profunktor" %% "fs2-rabbit-circe" % Version ``` -Note: previous artifacts `<= 2.0.0-RC1` were published using the `com.github.gvolpe` group id (see [migration -guide](https://github.com/profunktor/fs2-rabbit/wiki/Migration-guide-(Vim))) - ## Usage Guide Check the [official guide](https://fs2-rabbit.profunktor.dev/guide.html) for updated compiling examples.