Skip to content

Commit

Permalink
update docs for v.5
Browse files Browse the repository at this point in the history
  • Loading branch information
oshai committed Jul 13, 2023
1 parent 0db6882 commit 73808f7
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ class FooWithLogging {
}
```

An `Android` example project with kotlin-logging can be found in [kotlin-logging-example-android](https://github.com/oshai/kotlin-logging-example-android).

## Version 5 vs. previous versions

Expand Down Expand Up @@ -91,7 +90,7 @@ In short, if you just want to log statements to stdout, it's possible to add the
<dependency>
<groupId>io.github.oshai</groupId>
<artifactId>kotlin-logging-jvm</artifactId>
<version>5.0.0-beta-01</version>
<version>5.0.0-beta-04</version>
</dependency>
```
Or
Expand All @@ -106,7 +105,7 @@ See the full example in [kotlin-logging-example-maven](https://github.com/oshai/

### Gradle
```Groovy
implementation 'io.github.oshai:kotlin-logging-jvm:5.0.0-beta-01'
implementation 'io.github.oshai:kotlin-logging-jvm:5.0.0-beta-04'
```
Or
```Groovy
Expand All @@ -117,7 +116,7 @@ Alternatively, download the JAR from [github](https://github.com/oshai/kotlin-lo

### Multiplatform

An experimental common & JS & linux-x64 support is available.
An experimental multiplatform support is available.
More information is available on the [wiki](https://github.com/oshai/kotlin-logging/wiki/Multiplatform-support) and issues [#21](https://github.com/oshai/kotlin-logging/issues/21) [#45](https://github.com/oshai/kotlin-logging/issues/45).

## Overview
Expand All @@ -141,10 +140,10 @@ And many more... (add your name above)
## FAQ

- Why not use plain slf4j? kotlin-logging has better native Kotlin support. It adds more functionality and enables less boilerplate code.
- Is all slf4j implementation supported (Markers, params, etc')? Yes, kotlin-logging inherits Logger and all methods are supported.
- Is all slf4j implementation supported (Markers, params, etc')? Yes.
- Is location logging possible? Yes, location awareness was added in kotlin-logging 1.4.
- When I do `logger.debug`, my IntelliJ IDEA run console doesn't show any output. Do you know how I could set the console logger to debug or trace levels? Is this an IDE setting, or can it be set in the call to KLogging()? Setting log level is done per implementation. kotlin-logging and slf4j are just facades for the underlying logging lib (log4j, logback etc') more details [here](http://stackoverflow.com/questions/43146977/how-to-configure-kotlin-logging-logger).
- Can I access the actual logger? Yes, via `KLogger.underlyingLogger` property.
- Can I access the actual logger? In platforms available yes, via `DelegatingKLogger.underlyingLogger` property.

## Usage

Expand Down

0 comments on commit 73808f7

Please sign in to comment.