Skip to content

Commit

Permalink
Updated readme for new milestone
Browse files Browse the repository at this point in the history
  • Loading branch information
djspiewak committed Dec 21, 2020
1 parent a364b9e commit 5859b91
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,39 +4,39 @@ Cats Effect 3 (or "ce3") is an ongoing project designed to fully replace the exi

## Getting Started

At present, no final releases have been published for Cats Effect 3. We are, however, beginning to release stable milestones to allow the ecosystem to progressively migrate forward. The latest milestone release of Cats Effect 3 is [**3.0.0-M4**](https://github.com/typelevel/cats-effect/releases/tag/v3.0.0-M4). If you need a newer stable snapshot for whatever reason, get in touch with us [in Gitter](https://gitter.im/typelevel/cats-effect-dev)!
At present, no final releases have been published for Cats Effect 3. We are, however, beginning to release stable milestones to allow the ecosystem to progressively migrate forward. The latest milestone release of Cats Effect 3 is [**3.0.0-M5**](https://github.com/typelevel/cats-effect/releases/tag/v3.0.0-M5). If you need a newer stable snapshot for whatever reason, get in touch with us [in Gitter](https://gitter.im/typelevel/cats-effect-dev)!

If you're an end-user (i.e. writing an application, not a library), then you probably want the full, batteries-included dependency of **core**, which gives you access to `IO`, `IOApp`, and other goodies:

```scala
libraryDependencies += "org.typelevel" %% "cats-effect" % "3.0.0-M4"
libraryDependencies += "org.typelevel" %% "cats-effect" % "3.0.0-M5"
```

If you're a datatype implementation (like Monix), you probably only want to depend on **kernel** (the typeclasses) in your compile scope and **laws** in your test scope:

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

If you're a middleware framework (like fs2), you probably want to depend on **concurrent**, which gives you access to `Ref` and `Deferred` and such without introducing a hard-dependency on `IO` outside of your tests:

```scala
libraryDependencies ++= Seq(
"org.typelevel" %% "cats-effect-concurrent" % "3.0.0-M4",
"org.typelevel" %% "cats-effect" % "3.0.0-M4" % Test)
"org.typelevel" %% "cats-effect-concurrent" % "3.0.0-M5",
"org.typelevel" %% "cats-effect" % "3.0.0-M5" % Test)
```

You may also find some utility in the **testkit** project, which contains `TestContext`, `TimeT`, and a few other things:

```scala
libraryDependencies += "org.typelevel" %% "cats-effect-testkit" % "3.0.0-M4" % Test
libraryDependencies += "org.typelevel" %% "cats-effect-testkit" % "3.0.0-M5" % Test
```

Please note that there are no particular guarantees about binary compatibility until we get to a final release, or at the *very least* a release candidate. **Please do not put this into production yet.**

At the present time, ce3 is cross-built for Scala 2.12, 2.13, 3.0.0-M1, and 3.0.0-M2. ScalaJS cross-builds are available for all Scala versions, targeting SJS 1.3.0.
At the present time, ce3 is cross-built for Scala 2.12, 2.13, 3.0.0-M2, and 3.0.0-M3. ScalaJS cross-builds are available for all Scala versions, targeting SJS 1.3.0.

### Hello, World

Expand Down

0 comments on commit 5859b91

Please sign in to comment.