From ef98337fbe40c623185167c60dfa18550f6215dc Mon Sep 17 00:00:00 2001 From: Ohad Shai Date: Wed, 8 Jan 2025 18:00:38 +0200 Subject: [PATCH] Update README.md --- README.md | 40 +++++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 38abc61..c2a5c15 100644 --- a/README.md +++ b/README.md @@ -61,23 +61,6 @@ class FooWithLogging { } ``` - -## Version 5 vs. previous versions - -Version 5 is not backward compatible with previous versions (v.3, v.2, v.1). Group id (in maven) and packages names changed. -It is possible to use both version 5 and previous versions side-by-side so some of the code from the old version -and some new. It is also possible to have libs using old version and use the new version (and vice-versa). -In that sense it's a completely new dependency. - -Main changes are: -- Maven group id changed from `io.github.microutils` -> `io.github.oshai`. -- Root package change from `mu` -> `io.github.oshai.kotlinlogging`. -- Slf4j dependency is not provided anymore (users have to provide it). It means that >= 5.x can work with both slf4j 1 or 2. -- There are changes to multiplatform class hierarchy that might break compatibility. - -More details in issue [#264](https://github.com/oshai/kotlin-logging/issues/264), -and in the [change log](https://github.com/oshai/kotlin-logging/blob/master/ChangeLog.md) - ## Download **Important note:** kotlin-logging depends on slf4j-api (in the JVM artifact). In runtime, it is also required to depend on a logging implementation. More details in [how-to-configure-slf4j](http://saltnlight5.blogspot.co.il/2013/08/how-to-configure-slf4j-with-different.html). And an excellent detailed explanation in [a-guide-to-logging-in-java](https://www.marcobehler.com/guides/a-guide-to-logging-in-java). @@ -90,7 +73,7 @@ In short, if you just want to log statements to stdout, it's possible to add the io.github.oshai kotlin-logging-jvm - 7.0.0 + 7.0.3 ``` @@ -98,7 +81,7 @@ See the full example in [kotlin-logging-example-maven](https://github.com/oshai/ ### Gradle ```Groovy -implementation 'io.github.oshai:kotlin-logging-jvm:7.0.0' +implementation 'io.github.oshai:kotlin-logging-jvm:7.0.3' ``` @@ -116,6 +99,25 @@ After seeing many questions like [Idiomatic way of logging in Kotlin](http://sta - A straight forward way to log messages with lazy-evaluated string using lambda expression `{}`. - All previous slf4j implementation can still be used. + +## Version 5 vs. previous versions + +Version 5 is not backward compatible with previous versions (v.3, v.2, v.1). Group id (in maven) and packages names changed. +It is possible to use both version 5 and previous versions side-by-side so some of the code from the old version +and some new. It is also possible to have libs using old version and use the new version (and vice-versa). +In that sense it's a completely new dependency. + +Main changes are: +- Maven group id changed from `io.github.microutils` -> `io.github.oshai`. +- Root package change from `mu` -> `io.github.oshai.kotlinlogging`. +- Slf4j dependency is not provided anymore (users have to provide it). It means that >= 5.x can work with both slf4j 1 or 2. +- There are changes to multiplatform class hierarchy that might break compatibility. + +More details in issue [#264](https://github.com/oshai/kotlin-logging/issues/264), +and in the [change log](https://github.com/oshai/kotlin-logging/blob/master/ChangeLog.md) + + + ## Who is using it - https://www.jetbrains.com/youtrack/ (https://www.jetbrains.com/help/youtrack/standalone/Third-Party-Software-Used-by-YouTrack.html)