From 956bd75b77563c84a03382b16ac571fb3c571012 Mon Sep 17 00:00:00 2001
From: Waheed Nazir <39362210+WaheedNazir@users.noreply.github.com>
Date: Mon, 21 Jun 2021 02:14:59 +0800
Subject: [PATCH] Adding doc

---
 README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 60 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 1855e3a..20d03df 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,60 @@
-# TodoKotlinMVVMHilt
-Todo app developed using Kotlin with MVVM Architecture and Hilt as a dependency Injection. 
+## Kotlin MVVM Architecture
+
+A sample app to manage Todo list, Add, Delete, Update Todos. The purpose of this project to illustrate the usage of MVVM architecture design pattern that follow the best practices of Object Oriented Design Patterns using the following technology stack.
+
+ 1. Architecture Design Pattern
+ 2. MVVM
+ 2. Dagger2 (Dependency Injection) / Hilt
+ 3. Live Data, MediatorLiveData
+ 4. Room Database
+ 5. Retrofit
+ 6. Repository Pattern
+ 7. AndroidX
+ 8. NetworkBoundResource, NetworkAndDBBoundResource
+ 9. Google News API
+ 10. JetPack Libraries
+
+### Demo
+<img height="400px" src="https://github.com/WaheedNazir/Kotlin-MVVM-Architecture/blob/master/screens/sample_demo.gif" />
+
+## Architecture
+<img alt="MVVM Architecture" height="700px" src="https://github.com/WaheedNazir/Kotlin-MVVM-Architecture/blob/master/screens/Architecture_design_new.jpg" />
+
+
+## NetworkBoundResource
+<img alt="MVVM Architecture" height="500px" src="https://github.com/WaheedNazir/Kotlin-MVVM-Architecture/blob/master/screens/network-bound-resource.png" />
+
+
+# Mediator LiveData
+<img alt="MVVM Architecture" height="350px" src="https://github.com/WaheedNazir/Kotlin-MVVM-Architecture/blob/master/screens/Mediator_LiveData_Combined_These_Data_Sounrces.png" />
+
+
+### Other samples of MVVM using Kotlin
+
+* [View-ViewModel-Interaction] - Sample shows View and ViewModel Interaction/Communication.
+* [Communication-ActivityFragment-ViewModel] - Sample shows communication between Activity and Fragment using ViewModel
+* [ViewModel-ViewModel-Communication] - Sample shows communication between ViewModels
+* [LocationUpdates-LiveData-ViewModel] - Sample shows, to get location updates as LiveData in Kotlin.
+* [Kotlin-MVVM-Architecture] - Sample of complete MVVM Architecture using Dagger2, Kotlin, MediatorLiveData, Retrofit etc.
+* [Presentation Slides] - Presentation slides on this architecture sample.
+
+   [Kotlin-MVVM-Architecture]: <https://github.com/WaheedNazir/Kotlin-MVVM-Architecture>
+   [View-ViewModel-Interaction]: <https://github.com/WaheedNazir/View-ViewModel-Interaction>
+   [ViewModel-ViewModel-Communication]: <https://github.com/WaheedNazir/ViewModel-ViewModel-Communication>
+   [Communication-ActivityFragment-ViewModel]: <https://github.com/WaheedNazir/Communication-ActivityFragment-ViewModel>
+   [LocationUpdates-LiveData-ViewModel]: <https://github.com/WaheedNazir/LocationUpdates-LiveData-ViewModel>
+   [Presentation Slides]: <https://github.com/WaheedNazir/Kotlin-MVVM-Architecture/blob/master/Presentation_WaheedNazir_FINAL.pdf>
+
+   
+
+
+
+## Author
+[Waheed Nazir](https://github.com/WaheedNazir "Waheed Nazir (WaveTechStudio)")
+
+
+## Sources
+ 1. [Google's official doc](https://developer.android.com/jetpack/docs/guide)
+ 2. [Google's Codelab](https://codelabs.developers.google.com/codelabs/android-training-livedata-viewmodel/#0)
+ 2. [Architecture Components Samples](https://github.com/android/architecture-components-samples/tree/88747993139224a4bb6dbe985adf652d557de621)
+ 3. [Jose Alcérreca's post at Medium](https://medium.com/androiddevelopers/livedata-beyond-the-viewmodel-reactive-patterns-using-transformations-and-mediatorlivedata-fda520ba00b7)