Merge pull request #506 from kevin-lee/update-docs

Update: docs - getting started - add how to get for scala-cli
kevin-lee · Nov 29, 2023 · 532c057 · 532c057
2 parents c421319 + a7994ef
commit 532c057
Showing 1 changed file with 157 additions and 16 deletions.
diff --git 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.
 :::
 
+<Tabs
+groupId="slf4j"
+defaultValue="slf4j-sbt"
+values={[
+{label: 'sbt', value: 'slf4j-sbt'},
+{label: 'sbt (with libraryDependencies)', value: 'slf4j-sbt-lib'},
+{label: 'scala-cli', value: 'slf4j-scala-cli'},
+]}>
+<TabItem value="slf4j-sbt">
+
 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@",
 ```
 
+  </TabItem>
+
+  <TabItem value="slf4j-sbt-lib">
+
+In `build.sbt`,
+
+```scala
+libraryDependencies ++= Seq(
+    "io.kevinlee" %% "logger-f-cats" % "@VERSION@",
+    "io.kevinlee" %% "logger-f-slf4j" % "@VERSION@",
+  )
+```
+
+  </TabItem>
+
+  <TabItem value="slf4j-scala-cli">
+
+```scala
+//> using dep "io.kevinlee::logger-f-cats:@VERSION@"
+//> using dep "io.kevinlee::logger-f-slf4j:@VERSION@"
+```
+
+  </TabItem>
+</Tabs>
+
+
 #### With Log4j
 
+<Tabs
+groupId="log4j"
+defaultValue="log4j-sbt"
+values={[
+{label: 'sbt', value: 'log4j-sbt'},
+{label: 'sbt (with libraryDependencies)', value: 'log4j-sbt-lib'},
+{label: 'scala-cli', value: 'log4j-scala-cli'},
+]}>
+<TabItem value="log4j-sbt">
+
+In `build.sbt`,
+
+```scala
+"io.kevinlee" %% "logger-f-cats" % "@VERSION@",
+"io.kevinlee" %% "logger-f-log4j" % "@VERSION@",
+```
+
+  </TabItem>
+
+  <TabItem value="log4j-sbt-lib">
+
+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@",
+  )
 ```
 
+  </TabItem>
+
+  <TabItem value="log4j-scala-cli">
+
+```scala
+//> using dep "io.kevinlee::logger-f-cats:@VERSION@"
+//> using dep "io.kevinlee::logger-f-log4j:@VERSION@"
+```
+
+  </TabItem>
+</Tabs>
+
+
 #### With Log4s
 
+<Tabs
+groupId="log4s"
+defaultValue="log4s-sbt"
+values={[
+{label: 'sbt', value: 'log4s-sbt'},
+{label: 'sbt (with libraryDependencies)', value: 'log4s-sbt-lib'},
+{label: 'scala-cli', value: 'log4s-scala-cli'},
+]}>
+<TabItem value="log4s-sbt">
+
+In `build.sbt`,
+
+```scala
+"io.kevinlee" %% "logger-f-cats" % "@VERSION@",
+"io.kevinlee" %% "logger-f-log4s" % "@VERSION@",
+```
+
+  </TabItem>
+
+  <TabItem value="log4s-sbt-lib">
+
+In `build.sbt`,
+
+```scala
+libraryDependencies ++= Seq(
+    "io.kevinlee" %% "logger-f-cats" % "@VERSION@",
+    "io.kevinlee" %% "logger-f-log4s" % "@VERSION@",
+  )
+```
+
+  </TabItem>
+
+  <TabItem value="log4s-scala-cli">
+
 ```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@"
 ```
 
+  </TabItem>
+</Tabs>
+
+
 #### With sbt Logging Util
 For sbt plugin development,
 
+<Tabs
+groupId="sbt-logging"
+defaultValue="sbt-logging-sbt"
+values={[
+{label: 'sbt', value: 'sbt-logging-sbt'},
+{label: 'sbt (with libraryDependencies)', value: 'sbt-logging-sbt-lib'},
+{label: 'scala-cli', value: 'sbt-logging-scala-cli'},
+]}>
+<TabItem value="sbt-logging-sbt">
+
+In `build.sbt`,
+
+```scala
+"io.kevinlee" %% "logger-f-cats" % "@VERSION@",
+"io.kevinlee" %% "logger-f-sbt-logging" % "@VERSION@",
+```
+
+  </TabItem>
+
+  <TabItem value="sbt-logging-sbt-lib">
+
+In `build.sbt`,
+
+```scala
+libraryDependencies ++= Seq(
+    "io.kevinlee" %% "logger-f-cats" % "@VERSION@",
+    "io.kevinlee" %% "logger-f-sbt-logging" % "@VERSION@",
+  )
+```
+
+  </TabItem>
+
+  <TabItem value="sbt-logging-scala-cli">
+
 ```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@"
 ```
 
+  </TabItem>
+</Tabs>
+
 
 ## Why
 ### Log without LoggerF