Version 2.3.0

Author: philips77

README.md

@@ -2,24 +2,29 @@
 
 [ ![Download](https://api.bintray.com/packages/nordic/android/nrf-logger-api/images/download.svg) ](https://bintray.com/nordic/android/nrf-logger-api/_latestVersion)
 
-The library allows to easily create custom log entries from your application in the nRF Logger. It is being used by nRF Connect and nRF Toolbox, that are available on Google Play.
+The library allows to easily create custom log entries from your application in the 
+[nRF Logger](https://play.google.com/store/apps/details?id=no.nordicsemi.android.log). 
+It is being used by nRF Connect and nRF Toolbox, that are available on Google Play.
 The logger may be used for debugging purposes, as LogCat is not always available.
 
-nRF Logger is available for Android 4.1.* and newer.
+nRF Logger is available for Android 4.2.* and newer.
 
 ### Usage
-The nRF Logger API library is available as *jar* or from jcenter and Maven Central repositories. For Android Studio, add the following dependency to your component's *gradle.build* file:
+The nRF Logger API library is available on JCenter and Maven Central repositories. 
+For Android Studio, add the following dependency to your component's *gradle.build* file:
 
 ```Groovy
-implementation 'no.nordicsemi.android:log:2.2.0'
+implementation 'no.nordicsemi.android:log:2.3.0'
 ```
 
 For easy integration with [Timber (4.7.1)](https://github.com/JakeWharton/timber), use this instead:
 
 ```Groovy
-implementation 'no.nordicsemi.android:log-timber:2.2.0'
+implementation 'no.nordicsemi.android:log-timber:2.3.0'
 ```
 
+If your project is NOT migrated to AndroidX, use version 2.2.0.
+
 If you use proguard, the following line will be automatically added to your proguard rules:
 
 ```-keep class no.nordicsemi.android.log.** { *; }```
@@ -33,21 +38,26 @@ If you use proguard, the following line will be automatically added to your prog
 APPLICATION level added in version 2.0 of the library.
 
 ### Timber integration
-After importing log-timber dependency, plant the [nRFLoggerTree](https://github.com/NordicSemiconductor/nRF-Logger-API/blob/master/log-timber/src/main/java/no/nordicsemi/android/log/timber/nRFLoggerTree.java), as described on [Timber](https://github.com/JakeWharton/timber) website.
+After importing log-timber dependency, plant the 
+[nRFLoggerTree](https://github.com/NordicSemiconductor/nRF-Logger-API/blob/master/log-timber/src/main/java/no/nordicsemi/android/log/timber/nRFLoggerTree.java), 
+as described on [Timber](https://github.com/JakeWharton/timber) website.
 
 #### Important
-1. The log-timber library uses *android.support.annotation:28.0.0* `@NonNull` and `@Nullable`, instead of ones from *org.jetbrains.annotations*, like Timber does.
-2. Log levels that Timber uses are incompatible with those in nRF Logger. In Timber, the APPLICATION level is missing, and DEBUG has higher priority then VERBOSE.
+1. The log-timber library uses `@NonNull` and `@Nullable` from *androidx.annotation*, 
+   instead of ones from *org.jetbrains.annotations*, like Timber does.
+2. Log levels that Timber uses are incompatible with those in nRF Logger. 
+   In Timber, the APPLICATION level is missing, and DEBUG has higher priority then VERBOSE.
 3. Using Timber's (e.g. `Timber.i(...)`) API it is not possible to log on APPLICATION level.
 4. Logs logged with `Log.VERBOSE` priority will get VERBOSE log level, so will be upgraded.
 5. Logs logged with `Log.DEBUG` priority will get DEBUG level, so will be downgraded.
 6. Tags will be added before the message: `[TAG] message`.
 
 ### Example
-The example project may be found in samples folder. It contains a simple application that shows how to create a log session:
+The example project may be found in samples folder. It contains a simple application that shows 
+how to create a log session:
 ```java
 logSession = Logger.newSession(context, key, name);
-```	
+```
 and add entries:
 ```java
 Logger.log(logSession, Level.INFO, text);
@@ -59,11 +69,14 @@ If nRF Logger application is not installed on the device those methods does noth
 
 ![Logger Image](.assets/logger2.png) ![Logger Image](.assets/logger1.png)
 
-(1) When you create your first log session from your application its name will be added to nRF Logger drop-down menu.
+(1) When you create your first log session from your application its name will be added to nRF Logger 
+    drop-down menu.
 ```java
 logSession = Logger.newSession(context, key, name);
 ```
-(2) You may create multiple folders for different components of your application by creating a session with a profile name. It will be concatenated with the application name and visible as different entry in the drop-down menu.
+(2) You may create multiple folders for different components of your application by creating a session 
+    with a profile name. It will be concatenated with the application name and visible as different 
+    entry in the drop-down menu.
 ```java
 logSession = Logger.newSession(context, "Profile Name", key, name);
 ```
@@ -85,17 +98,26 @@ Logger.setSessionMark(logSession, Logger.MARK_FLAG_RED);
 
 ### Local Log Content Provider
 
-The version 2.0 introduced the **LocalLogContentProvider** class which may be used to keep logs even if the nRF Logger application is not installed. Local log database is a limited version of the one in nRF Logger. It does not support multiple applications as the new provider is designed to work only in one application. Also marking session with a flag/star or adding a description is not supported.
+The version 2.0 introduced the **LocalLogContentProvider** class which may be used to keep logs even 
+if the nRF Logger application is not installed. Local log database is a limited version of the one 
+in nRF Logger. It does not support multiple applications as the new provider is designed to work only 
+in one application. Also marking session with a flag/star or adding a description is not supported.
 
-To use the LocalLogContentProvider you must extend extend this class in you project and add its definition to the *AndroidManifest.xml* file:
+To use the LocalLogContentProvider you must extend extend this class in you project and add its 
+definition to the *AndroidManifest.xml* file:
 ```xml
 <provider
     android:name="com.example.log.provider.MyLogContentProvider"
     android:authorities="com.example.log"
     android:exported="true" />
 ```        
-If you want to use the local logger in threads that are owned by other applications, f.e. by Bluetooth scanner callbacks, you must set the **exported** attribute to *true*. Otherwise the Bluetooth application will not have the permission to add log events. You may also use **Handler** object to log in UI thread of your application.
+If you want to use the local logger in threads that are owned by other applications, e.g. by Bluetooth 
+scanner callbacks, you must set the **exported** attribute to *true*. Otherwise the Bluetooth application 
+will not have the permission to add log events. You may also use **Handler** object to log in 
+UI thread of your application.
 
 ### ILogSession
 
-In order to make the LocalLogSession work a new interface has been created - **ILogSession**. Both **LogSession** and **LocalLogSession** implement this interface. You will need to change the type of your *mLogSession* object to **ILogSession** when migrating to version 2.0 of the library.
+In order to make the `LocalLogSession` work, a new interface has been created - `ILogSession`. 
+Both `LogSession` and `LocalLogSession` implement this interface. You will need to change the 
+type of your `mLogSession` object to `ILogSession` when migrating to version 2.0 of the library.

gradle.properties

@@ -17,7 +17,7 @@
 android.useAndroidX=true
 android.enableJetifier=true
 
-VERSION_NAME=2.2.0
+VERSION_NAME=2.3.0
 GROUP=no.nordicsemi.android
 
 POM_DESCRIPTION=nRF Logger API Library