update readme

Author: Dorofeev

README.md

@@ -1,9 +1,9 @@
-
+[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0) [![Download]
 ![kotlin-version](https://img.shields.io/badge/kotlin-1.4.10-orange)
 
 # Mobile Kotlin crash report
 
-coming soon...
+This is a Kotlin MultiPlatform library that provides reporting fatal and non-fatal exceptions from common code.
 
 ## Table of Contents
 - [Features](#features)
@@ -17,7 +17,8 @@ coming soon...
 - [License](#license)
 
 ## Features
-
+- **CrashlyticsLogger** implementation of **ExceptionLogger**, for logging messages and non-fatals to FirebaseCrashlytics.
+- **CrashReportingAntilog** can be used for **Napier** logger to log messages and errors by **ExceptionLogger**
 
 ## Requirements
 - Gradle version 6.0+
@@ -29,13 +30,94 @@ coming soon...
   - 0.1.0
 
 ## Installation
-
+root build.gradle  
+```groovy
+allprojects {
+    repositories {
+        maven { url = "https://dl.bintray.com/icerockdev/moko" }
+        maven { url = uri("https://dl.bintray.com/aakira/maven") } // for CrashReportingAntilog
+    }
+}
+```
+project build.gradle
+```groovy
+dependencies {
+commonMainApi("dev.icerock.moko:crash-reporting-core:0.1.0")
+    commonMainApi("dev.icerock.moko:crash-reporting-crashlytics:0.1.0") // for CrashlyticsLogger
+    commonMainApi("dev.icerock.moko:crash-reporting-napier:0.1.0") // for CrashReportingAntilog
+    commonMainImplementation("com.github.aakira:napier:1.4.1") // for CrashReportingAntilog
+}
+```
+For CrashlyticsLogger need to add FirebaseCrashlytics cocoapod
+With [mobile-multiplatform-gradle-plugin](https://github.com/icerockdev/mobile-multiplatform-gradle-plugin) cocoapods configuration simplest:
+`build.gradle.kts`:
+```kotlin
+cocoaPods {
+    podsProject = file("ios-app/Pods/Pods.xcodeproj")
+
+    pod("GoogleUtilities", onlyLink = false)
+    pod("FirebaseCrashlytics", onlyLink = true)
+}
+```
+project Podfile
+```ruby
+pod 'Firebase', '6.33.0'
+pod 'FirebaseCrashlytics', '4.6.1'
+```
 ## Usage
 
+### CrashlyticsLogger
+If you haven't already, add Firebase to your project, you can see how to do it [here](https://firebase.google.com/docs/crashlytics/get-started)
+
+```kotlin
+val logger = CrashlyticsLogger()
+
+// setting user id in crashlytics 
+logger.setUserId("User_1")
+
+// setting custom key-value in crashlytics 
+logger.setCustomValue("customValue", "customKey")
+
+// log message in crashlytics
+logger.log("Hello World")
+
+// send non-fatal exception to crashlytics
+try {
+    "test".toInt()
+} catch (e: NumberFormatException) {
+    logger.recordException(e)
+}
+```
+
+### CrashReportingAntilog
+```kotlin
+val logger = CrashlyticsLogger() // CrashlyticsLogger for example, you can use any ExceptionLogger implementation
+
+// initialize napier
+Napier.base(antilog = CrashReportingAntilog(exceptionLogger = logger))
+
+// All messages will be logged by exceptionLogger
+Napier.d(message = "Hello World")
+Napier.i(message = "This is random message", tag = "FYI")
+Napier.w(message = "Something goes wrong", tag = "Alarm")
+Napier.v(message = "just verbose", tag = "VERBOSE")
+
+// throwable will be recorded by exceptionLogger
+try {
+    "test".toInt()
+} catch (e: NumberFormatException) {
+    Napier.e(message = "test is not a number", tag = "Non fatal", throwable = e)
+}
+```
+
 ## Samples
 Please see more examples in the [sample directory](sample).
 
 ## Set Up Locally 
+- The [crash-reporting-core](crash-reporting-core) contains basic classes and interfaces needed for crash reporting;
+- The [crash-reporting-crashlytics](crash-reporting-crashlytics) contains integraion with firebase crashlytics;
+- The [crash-reporting-napier](crash-reporting-napier) contains integration with [napier](https://github.com/AAkira/Napier) logger;
+- The [sample directory](sample) contains sample apps for Android and iOS; plus the mpp-library connected to the apps.
 
 
 ## Contributing

sample/ios-app/Podfile.lock

@@ -71,7 +71,7 @@ PODS:
   - PromisesObjC (1.2.10)
 
 DEPENDENCIES:
-  - Firebase
+  - Firebase (= 6.33.0)
   - FirebaseCrashlytics
   - MultiPlatformLibrary (from `../mpp-library`)
 
@@ -107,6 +107,6 @@ SPEC CHECKSUMS:
   nanopb: 59317e09cf1f1a0af72f12af412d54edf52603fc
   PromisesObjC: b14b1c6b68e306650688599de8a45e49fae81151
 
-PODFILE CHECKSUM: e2c288540b0b80c13ea5efa9eef52317283eeedc
+PODFILE CHECKSUM: cda8a19268eedbd8de1aa68cc1eba57c7ea56ffb
 
 COCOAPODS: 1.9.3