diff --git a/docs/latest/getting-started.md b/docs/latest/getting-started.md index 5608bb84..fa052048 100644 --- a/docs/latest/getting-started.md +++ b/docs/latest/getting-started.md @@ -39,43 +39,184 @@ logger-f can be used wit any effect library or `Future` as long as there is an i If you use logback, please use this. ::: + + + In `build.sbt`, ```scala -Seq( - "io.kevinlee" %% "logger-f-cats" % "@VERSION@", - "io.kevinlee" %% "logger-f-slf4j" % "@VERSION@" -) +"io.kevinlee" %% "logger-f-cats" % "@VERSION@", +"io.kevinlee" %% "logger-f-slf4j" % "@VERSION@", ``` + + + + +In `build.sbt`, + +```scala +libraryDependencies ++= Seq( + "io.kevinlee" %% "logger-f-cats" % "@VERSION@", + "io.kevinlee" %% "logger-f-slf4j" % "@VERSION@", + ) +``` + + + + + +```scala +//> using dep "io.kevinlee::logger-f-cats:@VERSION@" +//> using dep "io.kevinlee::logger-f-slf4j:@VERSION@" +``` + + + + + #### With Log4j + + + +In `build.sbt`, + +```scala +"io.kevinlee" %% "logger-f-cats" % "@VERSION@", +"io.kevinlee" %% "logger-f-log4j" % "@VERSION@", +``` + + + + + +In `build.sbt`, + ```scala -Seq( - "io.kevinlee" %% "logger-f-cats" % "@VERSION@", - "io.kevinlee" %% "logger-f-log4j" % "@VERSION@" -) +libraryDependencies ++= Seq( + "io.kevinlee" %% "logger-f-cats" % "@VERSION@", + "io.kevinlee" %% "logger-f-log4j" % "@VERSION@", + ) ``` + + + + +```scala +//> using dep "io.kevinlee::logger-f-cats:@VERSION@" +//> using dep "io.kevinlee::logger-f-log4j:@VERSION@" +``` + + + + + #### With Log4s + + + +In `build.sbt`, + +```scala +"io.kevinlee" %% "logger-f-cats" % "@VERSION@", +"io.kevinlee" %% "logger-f-log4s" % "@VERSION@", +``` + + + + + +In `build.sbt`, + +```scala +libraryDependencies ++= Seq( + "io.kevinlee" %% "logger-f-cats" % "@VERSION@", + "io.kevinlee" %% "logger-f-log4s" % "@VERSION@", + ) +``` + + + + + ```scala -Seq( - "io.kevinlee" %% "logger-f-cats" % "@VERSION@", - "io.kevinlee" %% "logger-f-log4s" % "@VERSION@" -) +//> using dep "io.kevinlee::logger-f-cats:@VERSION@" +//> using dep "io.kevinlee::logger-f-log4s:@VERSION@" ``` + + + + #### With sbt Logging Util For sbt plugin development, + + + +In `build.sbt`, + +```scala +"io.kevinlee" %% "logger-f-cats" % "@VERSION@", +"io.kevinlee" %% "logger-f-sbt-logging" % "@VERSION@", +``` + + + + + +In `build.sbt`, + +```scala +libraryDependencies ++= Seq( + "io.kevinlee" %% "logger-f-cats" % "@VERSION@", + "io.kevinlee" %% "logger-f-sbt-logging" % "@VERSION@", + ) +``` + + + + + ```scala -Seq( - "io.kevinlee" %% "logger-f-cats" % "@VERSION@", - "io.kevinlee" %% "logger-f-sbt-logging" % "@VERSION@" -) +//> using dep "io.kevinlee::logger-f-cats:@VERSION@" +//> using dep "io.kevinlee::logger-f-sbt-logging:@VERSION@" ``` + + + ## Why ### Log without LoggerF