Merge pull request #40 from boschglobal/feature-10

Add Quickstart guide

README.md

@@ -6,5 +6,93 @@ This is an Android SDK for the [KUKSA Vehicle Abstraction Layer](https://github.
 [![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Gitter](https://img.shields.io/gitter/room/kuksa-val/community)](https://gitter.im/kuksa-val/community)
 
+## Overview
 
-It allows you to access VSS data from KUKSA databroker using an Android System.
+The KUKSA Android SDK allows you to interact with [VSS data](https://covesa.github.io/vehicle_signal_specification/) 
+from the [KUKSA Databroker](https://github.com/eclipse/kuksa.val/tree/master/kuksa_databroker)
+within an Android App. The main functionality consists of fetching, updating and subscribing to VSS data. 
+
+## Integration
+
+*build.gradle*
+```
+implementation("org.eclipse.kuksa:kuksa-sdk:<VERSION>")
+```
+
+The latest release version can be seen [here](https://github.com/eclipse-kuksa/kuksa-android-sdk/releases).
+
+Snapshot builds are also available (but of course less stable): [Package view](https://github.com/eclipse-kuksa/kuksa-android-sdk/packages/1986280/versions)
+
+See the [quickstart guide](https://github.com/eclipse-kuksa/kuksa-android-sdk/tree/main/docs/QUICKSTART.md) for 
+additional integration options.
+
+### GitHub packages
+
+The KUKSA SDK is currently uploaded to [GitHub packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry)
+where an [authentication](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#authenticating-to-github-packages)
+is needed to download the dependency.
+
+```
+maven {
+    url = uri("https://maven.pkg.github.com/eclipse-kuksa/kuksa-android-sdk")
+    credentials {
+        username = <USERNAME>
+        password = <GITHUB_TOKEN>
+    }
+}
+```
+
+## Usage
+
+> [!NOTE]
+> The following snippet expects an **unsecure** setup of the Databroker. See the [quickstart guide](https://github.com/eclipse-kuksa/kuksa-android-sdk/blob/main/docs/QUICKSTART.md)
+> for instructions on how to establish a **secure** connection to the Databroker.
+
+```kotlin
+private var dataBrokerConnection: DataBrokerConnection? = null
+
+fun connectInsecure(host: String, port: Int) {
+    lifecycleScope.launch {
+        val managedChannel = ManagedChannelBuilder.forAddress(host, port)
+            .usePlaintext()
+            .build()
+
+        val connector = DataBrokerConnector(managedChannel)
+        dataBrokerConnection = connector.connect()
+        // Connection to the Databroker successfully established
+    } catch (e: DataBrokerException) {
+        // Connection to the Databroker failed
+    }
+}
+```
+
+```kotlin
+fun fetch() {
+    lifecycleScope.launch {
+        val property = Property("Vehicle.Speed", listOf(Field.FIELD_VALUE))
+        val response = dataBrokerConnection?.fetch(property) ?: return@launch
+        val entry = entriesList.first() // Don't forget to handle empty responses
+        val value = entry.value
+        val speed = value.float
+    }
+}
+```
+
+Refer to the [quickstart guide](https://github.com/eclipse-kuksa/kuksa-android-sdk/tree/main/docs/QUICKSTART.md) or
+[class diagrams](https://github.com/eclipse-kuksa/kuksa-android-sdk/blob/main/docs/kuksa-sdk_class-diagram.puml) for 
+further insight into the KUKSA SDK API. You can also checkout the [sample](https://github.com/eclipse-kuksa/kuksa-android-sdk/tree/main/samples) implementation.
+
+## Requirements
+
+- A working setup requires at least a running KUKSA [Databroker](https://github.com/eclipse/kuksa.val/tree/master/kuksa_databroker) 
+- Optional: The [KUKSA Databroker CLI](https://github.com/eclipse/kuksa.val/tree/master/kuksa_databroker) can be used to manually feed data and test your app. 
+  See [this chapter](https://github.com/eclipse/kuksa.val/tree/master/kuksa_databroker#reading-and-writing-vss-data-using-the-cli) on how to read and write data via the CLI.
+- Optional: The [Mock Service](https://github.com/eclipse/kuksa.val.services/tree/main/mock_service) can be used to simulate a "real" environment. 
+
+## Contribution
+
+Please feel free to create [GitHub issues](https://github.com/eclipse-kuksa/kuksa-android-sdk/issues) and [contribute](https://github.com/eclipse-kuksa/kuksa-android-sdk/blob/main/docs/CONTRIBUTING.md).
+
+## License
+
+The KUKSA Android SDK is provided under the terms of the [Apache Software License 2.0](https://github.com/eclipse-kuksa/kuksa-android-sdk/blob/main/LICENSE).

docs/CONTRIBUTING.md

@@ -35,6 +35,7 @@ The following types are supported:
       {"type": "docs", "section": "Documentation"},
       {"type": "perf", "section": "Performance"},
       {"type": "refactor", "section": "Refactoring"},
+      {"type": "revert", "section": "Reverts"},
       {"type": "test", "section": "Tests"},
       {"type": "chore", "hidden": true},
       {"type": "style", "hidden": true},