diff --git a/docs/latest/getting-started.md b/docs/latest/getting-started.md index 2ea8cd60..ee608425 100644 --- a/docs/latest/getting-started.md +++ b/docs/latest/getting-started.md @@ -28,29 +28,80 @@ A set of type-classes and utils for functional effect libraries (i.e. Cats Effe Why Effectie? Please read ["Why?"](#why) section. ## Getting Started -### For Cats Effect +### For Cats Effect 3 + + + In `build.sbt`, +```scala +"io.kevinlee" %% "effectie-cats-effect3" % "@VERSION@" +``` + + + + + +In `build.sbt`, + +```scala +libraryDependencies += "io.kevinlee" %% "effectie-cats-effect3" % "@VERSION@" +``` + + + + + +```scala +//> using dep "io.kevinlee::effectie-cats-effect3:@VERSION@" +``` + + + + + +### For Cats Effect 2 + - + + +In `build.sbt`, ```scala -libraryDependencies += "io.kevinlee" %% "effectie-cats-effect3" % "@VERSION@" +"io.kevinlee" %% "effectie-cats-effect2" % "@VERSION@" ``` - + + +In `build.sbt`, ```scala libraryDependencies += "io.kevinlee" %% "effectie-cats-effect2" % "@VERSION@" +``` + + + + + +```scala +//> using dep "io.kevinlee::effectie-cats-effect2:@VERSION@" ``` @@ -61,12 +112,44 @@ For more details, check out [Effectie for Cats Effect](cats-effect2/cats-effect2 ### For Monix + + + +In `build.sbt`, + +```scala +"io.kevinlee" %% "effectie-monix3" % "@VERSION@" +``` + + + + + In `build.sbt`, ```scala libraryDependencies += "io.kevinlee" %% "effectie-monix3" % "@VERSION@" ``` + + + + +```scala +//> using dep "io.kevinlee::effectie-monix3:@VERSION@" +``` + + + + + For more details, check out [Effectie for Monix](monix3/monix3.md).