Create README.md

jcaiqueoliveira · Oct 19, 2019 · 724967d · 724967d
1 parent cc404a5
commit 724967d
Showing 1 changed file with 39 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,39 @@
+# Dialetus
+
+Android repository for [Dialetus](https://github.com/mvfsillva/dialetus)
+
+[Api Documentation](https://github.com/mvfsillva/dialetus-service#-api)
+
+## Building and Running
+
+### Running from IDE
+
+- Ensure you have Android Studio 3.5.1 or newer
+- Is recommend to install Kotlinx.Serialization plugin on your IDE ([instructions](https://github.com/Kotlin/kotlinx.serialization))
+
+### Building from CLI
+
+To run all unit tests and build a APK, execute
+
+```
+./gradlew build
+```
+
+### Running integration tests
+
+To run acceptance tests powered by Instrumentation + Espresso, execute
+
+```
+./gradlew connectedCheck
+```
+## Knowledge Stack
+
+This project leverages on
+
+- Kotlin
+- Coroutines for Threading
+- Kodein for Dependency Injection
+- Kotlinx.Serialization for automatic JSON handling
+- OkHttp4 + Retrofit for networking over HTTP
+
+