Update README.md

oshai · Sep 20, 2020 · b225e1f · b225e1f
1 parent 59869dc
commit b225e1f
Showing 1 changed file with 16 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -52,8 +52,6 @@ An `Android` example project with kotlin-logging can be found in [kotlin-logging
 
 In short, if you just want to log statements to stdout, it's possible to add the following dependency: `org.slf4j:slf4j-simple:1.7.29`.
 
-**Multiplatform:** See the [section below](https://github.com/MicroUtils/kotlin-logging/blob/master/README.md#multiplatform).
-
 ### Maven
 ```xml
 <dependency>
@@ -71,6 +69,22 @@ compile 'io.github.microutils:kotlin-logging:1.12.0'
 
 Alternatively, download the JAR from [github](https://github.com/MicroUtils/kotlin-logging/releases/latest) or [bintray](https://dl.bintray.com/microutils/kotlin-logging/io/github/microutils/kotlin-logging/) or [maven-central](http://repo1.maven.org/maven2/io/github/microutils/kotlin-logging/).
 
+### Version 2.x
+
+** There are currently two supported branches: 1.x and 2.x **
+The main incompatible change is in the artifact names. In version `1.x` the jvm artifact is called `kotlin-logging` while in version `2.x` it's called `kotlin-logging-jvm` to comply with multiplatform schema.
+
+For example, to use kotlin-logging for jvm in version 2.0.2 add the following gradle dependency:
+```Groovy
+compile 'io.github.microutils:kotlin-logging-jvm:2.0.2'
+```
+
+#### Multiplatform
+
+An experimental common & JS & linux-x64 support is available.  
+More information is available on the [wiki](https://github.com/MicroUtils/kotlin-logging/wiki/Multiplatform-support) and issues [#21](https://github.com/MicroUtils/kotlin-logging/issues/21) [#45](https://github.com/MicroUtils/kotlin-logging/issues/45).
+
+
 ### Snapshot builds
 To get the latest non-stable version of kotlin logging use the following gradle configuration:
 ```Groovy
@@ -84,11 +98,6 @@ dependencies {
 ```
 * The latest snapshot version can be seen in [build.gradle.kts](https://github.com/MicroUtils/kotlin-logging/blob/master/build.gradle.kts) and in [artifactory](https://oss.jfrog.org/artifactory/webapp/#/artifacts/browse/tree/General/oss-snapshot-local/io/github/microutils/kotlin-logging).
 
-## Multiplatform
-
-An experimental common & JS support is available.  
-More information is available on the [wiki](https://github.com/MicroUtils/kotlin-logging/wiki/Multiplatform-support) and issue [#21](https://github.com/MicroUtils/kotlin-logging/issues/21).
-
 ## Overview
 
 After seeing many questions like [Idiomatic way of logging in Kotlin](http://stackoverflow.com/questions/34416869/idiomatic-way-of-logging-in-kotlin) and [Best practices for loggers](https://discuss.kotlinlang.org/t/best-practices-for-loggers/226/15), it seems like there should be a standard for logging and obtaining a logger in Kotlin. kotlin-logging provides a wrapper for slf4j-api to be used by Kotlin classes with the following advantages: