From 724967d0815f3452bacd430541665a901c79e67c Mon Sep 17 00:00:00 2001
From: Caique Oliveira <j.caique_fla@hotmail.com>
Date: Sat, 19 Oct 2019 12:19:30 -0300
Subject: [PATCH] Create README.md

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e68d61f
--- /dev/null
+++ 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
+
+