Merge branch 'master' of github.com:razir/GithubTestClient

Author: Anton Hadutski

README.md

@@ -19,55 +19,57 @@ This client is made for test purpose only. It's not related to Gitbub Inc. in an
 
 ### Data package:
 - *main* 
- -- All models
+  * All models
 ### Datasource package
  - *main* 
- -- All repositories 
- -- All room database related code
- -- All API related initialization code
+   * All repositories 
+   * All room database related code
+   * All API related initialization code
  - *test* 
- -- Unit tests for some repositories
+   * Unit tests for some repositories
  - *androidTest* 
- -- AndroidJUnit tests for untested by JUnit repositories 
--- AndroidJUnit tests for room db
--- AndroidJUnit tests for Http client Interceptor
+   * AndroidJUnit tests for untested by JUnit repositories 
+   * AndroidJUnit tests for room db
+   * AndroidJUnit tests for Http client Interceptor
 ### Dependency injection [DI] package
 - *main* 
--- Koin modules definition related code
+   * Koin modules definition related code
 - *test* 
--- Koin modules definition Unit tests
+  * Koin modules definition Unit tests
 ### Domain.UseCase package
 - *main*
--- All use cases 
+  * All use cases 
 - *test*
--- Some use cases JUnit tests
+  * Some use cases JUnit tests
 - *androidTest*
---AndroidJUnit tests for the rest of untested by JUnit use cases
+  * AndroidJUnit tests for the rest of untested by JUnit use cases
 ### Extensions package
 - *main*
--- Kotlin extensions code
+  * Kotlin extensions code
 - *androidTest*
---AndroidJUnit for some extensions
+  * AndroidJUnit for some extensions
 ### Presentaion package
 - *main*
--- All UI related code + ViewModels
+  * All UI related code + ViewModels
 - *test*
--- JUnit tests for ViewModels
+  * JUnit tests for ViewModels
 - *androidTest*
--- Espresso+ Kakao tests for Activities and Fragments
+  * Espresso+ Kakao tests for Activities and Fragments
 
-### Instructions to run
+## Instructions to run
 
-To run from the sources you need: 
-1) create your own github oauth application
+#### To run from the sources you need: 
+1) create your own github oauth application with redirect url ```https://google.com```
 2) create text file ```github_client.properties``` in the root project folder with app details from step 1. 
 client_id={your_client_id_here}
 client_secret={your_client_secret_here}
 
-To run from the apk: 
+
+#### To run from the apk: 
  1) Download the latest release from here 
-### Short video demostrantion of app workflow
 
+### Short video demostrantion of app workflow
+   https://drive.google.com/open?id=1L9BRnS7qELimUwrrneMK-R3ndNktPEmO
 ### Todos
  - Write more UI tests
  - Add more functionality