Skip to content

Commit

Permalink
Update README.md (#823)
Browse files Browse the repository at this point in the history
* Update README.md
---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Peter Kotula <[email protected]>
  • Loading branch information
3 people authored Apr 19, 2024
1 parent 2a98a69 commit 054965b
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,12 @@ 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.1"
libraryDependencies += "dev.zio" %% "zio-logging" % "2.2.2"
```

The main module contains the following features:
* [console loggers](docs/console-logger.md)
* [file loggers](docs/file-logger.md)
* [reconfigurable logger](docs/reconfigurable-logger.md)
* [log metrics](docs/metrics.md)


Expand All @@ -44,10 +43,10 @@ Other modules:

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

// SLF4j v2 integration
libraryDependencies += "dev.zio" %% "zio-logging-slf4j2" % "2.2.1"
libraryDependencies += "dev.zio" %% "zio-logging-slf4j2" % "2.2.2"
```
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 @@ -57,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.1"
libraryDependencies += "dev.zio" %% "zio-logging-slf4j-bridge" % "2.2.2"

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

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 @@ -71,7 +70,7 @@ Other modules:

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

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 Down

0 comments on commit 054965b

Please sign in to comment.