Skip to content

Commit

Permalink
Add docs (#1010)
Browse files Browse the repository at this point in the history
  • Loading branch information
geirolz authored Nov 4, 2024
1 parent a13d0e3 commit 7df1a26
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit 7df1a26

Please sign in to comment.