Skip to content

Commit

Permalink
Fix README generation (#852)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrzejressel authored May 30, 2024
1 parent 3b0adbc commit c77dd02
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ In order to use this library, we need to add the following line in our `build.sb

```scala
// ZIO Logging backends
libraryDependencies += "dev.zio" %% "zio-logging" % "2.2.4"
libraryDependencies += "dev.zio" %% "zio-logging" % "2.3.0"
```

The main module contains the following features:
Expand All @@ -43,10 +43,10 @@ Other modules:

```scala
// SLF4j v1 integration
libraryDependencies += "dev.zio" %% "zio-logging-slf4j" % "2.2.4"
libraryDependencies += "dev.zio" %% "zio-logging-slf4j" % "2.3.0"

// SLF4j v2 integration
libraryDependencies += "dev.zio" %% "zio-logging-slf4j2" % "2.2.4"
libraryDependencies += "dev.zio" %% "zio-logging-slf4j2" % "2.3.0"
```
When to use this module: you are already using SLF4J logger in some other project, and you like to have same log outputs.
See SLF4J [v2](docs/slf4j2.md) or [v1](docs/slf4j1.md) section for more details.
Expand All @@ -56,10 +56,10 @@ Other modules:

```scala
// Using ZIO Logging for SLF4j v1 loggers, usually third-party non-ZIO libraries
libraryDependencies += "dev.zio" %% "zio-logging-slf4j-bridge" % "2.2.4"
libraryDependencies += "dev.zio" %% "zio-logging-slf4j-bridge" % "2.3.0"

// Using ZIO Logging for SLF4j v2 loggers, usually third-party non-ZIO libraries
libraryDependencies += "dev.zio" %% "zio-logging-slf4j2-bridge" % "2.2.4"
libraryDependencies += "dev.zio" %% "zio-logging-slf4j2-bridge" % "2.3.0"
```

When to use this module: you want to use some zio-logger implementation, but also you are using some java library which using SLF4J interface for logging.
Expand All @@ -70,7 +70,7 @@ Other modules:

```scala
// JPL integration
libraryDependencies += "dev.zio" %% "zio-logging-jpl" % "2.2.4"
libraryDependencies += "dev.zio" %% "zio-logging-jpl" % "2.3.0"
```

When to use this module: you are already using Java Platform/System Logger in some other project, and you like to have same log outputs.
Expand All @@ -81,14 +81,13 @@ Other modules:

```scala
// JUL bridge
libraryDependencies += "dev.zio" %% "zio-logging-jul-bridge" % "2.2.4"
libraryDependencies += "dev.zio" %% "zio-logging-jul-bridge" % "2.3.0"
```

When to use this module: you are already using JUL logger in some other project, and you like to have same log outputs.
See [java.util.logging bridge](docs/jul-bridge.md) section for more details.



## Example

Let's try an example of ZIO Logging which demonstrates a simple application of ZIO logging.
Expand Down
11 changes: 11 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,17 @@ Other modules:
See [Java Platform/System Logger](jpl.md) section for more details.


* java.util.logging bridge - with this logging bridge, it is possible to use `zio-logging` for JUL loggers (usually third-party non-ZIO libraries), add the one of following lines to your `build.sbt` file:

```scala
// JUL bridge
libraryDependencies += "dev.zio" %% "zio-logging-jul-bridge" % "@VERSION@"
```

When to use this module: you are already using JUL logger in some other project, and you like to have same log outputs.
See [java.util.logging bridge](jul-bridge.md) section for more details.


## Example

Let's try an example of ZIO Logging which demonstrates a simple application of ZIO logging.
Expand Down

0 comments on commit c77dd02

Please sign in to comment.