Skip to content

Commit

Permalink
Updated readme for 3.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
djspiewak committed Nov 28, 2021
1 parent 9c8af7d commit bd83733
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@

## Getting Started

- Wired: **3.2.9**
- Wired: **3.3.0**
- Tired: **2.5.4**

```scala
libraryDependencies += "org.typelevel" %% "cats-effect" % "3.2.9"
libraryDependencies += "org.typelevel" %% "cats-effect" % "3.3.0"
```

The above represents the core, stable dependency which brings in the entirety of Cats Effect. This is *most likely* what you want. All current Cats Effect releases are published for Scala 2.12, 2.13, 3.0.0-RC2 and RC3, and ScalaJS 1.5.x.
Expand All @@ -30,22 +30,22 @@ Depending on your use-case, you may want to consider one of the several other mo

```scala
libraryDependencies ++= Seq(
"org.typelevel" %% "cats-effect-kernel" % "3.2.9",
"org.typelevel" %% "cats-effect-laws" % "3.2.9" % Test)
"org.typelevel" %% "cats-effect-kernel" % "3.3.0",
"org.typelevel" %% "cats-effect-laws" % "3.3.0" % Test)
```

If you're a middleware framework (like fs2), you probably want to depend on **std**, which gives you access to `Queue`, `Semaphore`, and much more without introducing a hard-dependency on `IO` outside of your tests:

```scala
libraryDependencies ++= Seq(
"org.typelevel" %% "cats-effect-std" % "3.2.9",
"org.typelevel" %% "cats-effect" % "3.2.9" % Test)
"org.typelevel" %% "cats-effect-std" % "3.3.0",
"org.typelevel" %% "cats-effect" % "3.3.0" % Test)
```

You may also find some utility in the **testkit** and **kernel-testkit** projects, which contain `TestContext`, generators for `IO`, and a few other things:

```scala
libraryDependencies += "org.typelevel" %% "cats-effect-testkit" % "3.2.9" % Test
libraryDependencies += "org.typelevel" %% "cats-effect-testkit" % "3.3.0" % Test
```

Cats Effect provides backward binary compatibility within the 2.x and 3.x version lines, and both forward and backward compatibility within any major/minor line. This is analogous to the versioning scheme used by Cats itself, as well as other major projects such as ScalaJS. Thus, any project depending upon Cats Effect 2.2.1 can be used with libraries compiled against Cats Effect 2.0.0 or 2.2.3, but *not* with libraries compiled against 2.3.0 or higher.
Expand Down

0 comments on commit bd83733

Please sign in to comment.