update: readme and contributing (#36)

* Update shared initializer in README

* Add supported platforms to README

* Update Sentry Cocoa version reminder

* Update contributing

* Try out dynamic github pic change based on theme

* Update sentry logo based on theme color

* Add width to sentry logo

Author: buenaflor

CONTRIBUTING.md

@@ -1,27 +1,26 @@
 # Contributing
 
-This SDK still needs a lot of love.
+This is still an experimental SDK so we're more than happy to discuss feedback and receive pull requests!
 
-## Cocoa
+# Code style
+The project uses `ktlint` and `spotless` to make sure the code is formatted properly. 
+We recommend that you setup a `pre-commit` hook that runs a spotless check when you try to commit.
 
-[sentry-cocoa](https://github.com/getsentry/sentry-cocoa) is included via the [CocoaPods plugin of Gradle](https://kotlinlang.org/docs/reference/native/cocoapods.html).
-Libraries integrated with CocoaPods in an Kotlin Multiplatform module can only be built with Xcode, because the infrastracture of Kotlin [can't resolve CocoaPods](https://kotlinlang.org/docs/reference/native/cocoapods.html#current-limitations).
-This means that we have to use an Xcode project like [ios-cocoa](./Samples/ios-cocoa) to be able to test this library on Cocoa.
-Building for iOS or MacOS with Gradle results in the following error:
+# Git commit hook
 
-```
-Undefined symbols for architecture x86_64:
-  "_OBJC_CLASS_$_SentrySDK", referenced from:
-      objc-class-ref in result.o
-  "_OBJC_CLASS_$_SentryOptions", referenced from:
-      objc-class-ref in result.o
-ld: symbol(s) not found for architecture x86_64
+Navigate to the root folder and install the hook:
+
+```shell
+git config core.hooksPath .hooks/
 ```
 
-Publishing to Maven works tough.
+To run the build and tests:
+
+```shell
+make compile
+```
 
-**Help appreciated**: There exists the possibilty to include Objective-C frameworks with using [`cinterop`](https://kotlinlang.org/docs/reference/native/gradle_plugin.html#using-cinterop).
-The advantage with this would be that sentry-cocoa is directly integrated in
-the Kotlin Multiplatform library. It could happen that the CocoaPods plugin is extended to not depend on Xcode so using `cinterop` could become obsolete.
+# CI
 
-## JVM
+Build and tests are automatically run against branches and pull requests
+via GH Actions.

README.md

@@ -1,52 +1,58 @@
 <p align="center">
-    <a href="https://sentry.io" target="_blank" align="center">
-        <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
-    </a>
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://sentry-brand.storage.googleapis.com/sentry-logo-white.png">
+      <source media="(prefers-color-scheme: light)" srcset="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png">
+      <img alt="Shows a black logo in light color mode and a white one in dark color mode." src="https://user-images.githubusercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png" width="280">
+    </picture>
 <br/>
     <h1>Experimental Sentry SDK for Kotlin Multiplatform</h1>
 </p>
 
 This project is an experimental SDK for Kotlin Multiplatform.
-This SDK is a wrapper around different platforms such as JVM, Android, Cocoa that can be used on Kotlin Multiplatform.
+This SDK is a wrapper around different platforms such as JVM, Android, iOS, macOS, watchOS, tvOS that can be used on Kotlin Multiplatform.
 
-## Installation
+## Supported Platforms
 
-Clone or fork this repo. This SDK is under construction and therefore we only currently publish it to maven local:
+| Target Platform | Target preset |
+|:-------------:|-------------|
+| Android     | <ul><li>`android`</li></ul> |
+| Kotlin/JVM  | <ul><li>`jvm`</li></ul>
+| iOS         | <ul><li>`iosArm64`</li><li>`iosX64`</li><li>`iosSimulatorArm64`</li></ul>|
+| macOS       | <ul><li>`macosArm64`</li><li>`macosX64`</ul>|
+| watchOS     | <ul><li>`watchosArm32`</li><li>`watchosArm64`</li><li>`watchosX64`</li><li>`watchosSimulatorArm64`</li></ul>|
+| tvOS        | <ul><li>`tvosArm64`</li><li>`tvosX64`</li><li>`tvosSimulatorArm64`</li></ul>|
 
-```sh
-./gradlew publishToMavenLocal
-```
+## Configure Repository
 
-### Shared Module
-In your `build.gradle` of your shared module
+The Kotlin Multiplatform SDK is available in the Maven central repository. You can declare this repository in your build script as follows:
 
 ```gradle
 repositories {
-  // Because we only publish to maven local
-  mavenLocal()
+  mavenCentral()
 }
 ```
 
-Add this to your `commonMain` sourceSet.
+## Add dependency
+For a multiplatform project, you need to add the sentry-kotlin-multiplatform artifact to the `commonMain` source set:
 
-```gradle
-// Add this dependency to your commonMain sourceSet
-dependencies {
-  api("io.sentry:sentry-kotlin-multiplatform:0.0.1")
+```Kotlin
+val commonMain by getting {
+  dependencies {
+    api("io.sentry:sentry-kotlin-multiplatform:0.0.1")
+  }
 }
-
 ```
 
 ### Cocoa
 
-For iOS, iPadOS, MacOS, tvOS or watchOS we use CocoaPods to include [sentry-cocoa](https://github.com/getsentry/sentry-cocoa) into this SDK.
-One way to achieve this is to include the Sentry Cocoa SDK via the Kotlin CocoaPods extension.
+If you are targeting Apple platforms (iOS, macOS, watchOS, tvOS), then you need to use CocoaPods to include [Sentry Cocoa](https://github.com/getsentry/sentry-cocoa) into this SDK.
+One way to achieve this is to include the Sentry Cocoa SDK via the Kotlin CocoaPods extension. Be aware that your Sentry Cocoa version has to match the SDK's version. Currently the supported version is `~> 7.21.0` 
 
 ```gradle
 cocoapods {
   // ...
   
-  // Make sure this is the same version as the one used in the SDK
+  // Make sure Sentry Cocoa in your project matches this version
   pod("Sentry", "~> 7.21.0")
 
   framework {
@@ -150,3 +156,19 @@ class AppDelegate: NSObject, UIApplicationDelegate {
     }
 }
 ```
+
+## Debug Symbols for Apple targets
+
+A dSYM upload is required for Sentry to symbolicate your crash logs for viewing. The symbolication process unscrambles Apple’s crash logs to reveal the function, variables, file names, and line numbers of the crash. The dSYM file can be uploaded through the sentry-cli tool or through a Fastlane action. Please visit our [sentry.io guide](https://docs.sentry.io/clients/cocoa/dsym/) to get started on uploading debug symbols.
+
+ ## Troubleshooting
+
+ `WARNING: CocoaPods requires your terminal to be using UTF-8 encoding.
+    Consider adding the following to ~/.profile:
+    export LANG=en_US.UTF-8`
+
+  This is a known problem and can easily be fixed as described in this [Stack Overflow post](https://stackoverflow.com/a/69395720)
+
+ ## Contribution
+
+ Please see the [contribution guide](https://github.com/getsentry/sentry-kotlin-multiplatform/blob/main/CONTRIBUTING.md) before contributing