Update README.md

KirkBushman · Aug 11, 2019 · b0af41e · b0af41e
1 parent f351da3
commit b0af41e
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,27 @@
 # zammad-android
 Modern android client library for Zammad
+
+### Info
+
+zammad-android is a [Zammad](https://github.com/zammad/zammad) client that target the android platform specifically.
+It is built with Kotlin, Retrofit, Moshi, OkHttp.
+
+zammad-android it's hosted on Jitpack
+
+### How to install.
+
+```
+allprojects {
+    repositories {
+        ...
+        maven { url 'https://jitpack.io' }
+    }
+}
+
+dependencies {
+    implementation 'com.github.KirkBushman:zammad-android:Tag'
+}
+```
+
+### License
+This project is licensed under the MIT License