Merge branch 'master' of https://github.com/clint22/tmdb_sample_project

README.md

@@ -1,2 +1,21 @@
-# tmdb_sample_project
+# TMDB App
 Tmdb sample project is a demo application that is based on modern Android architectures. It will fetch the data from the network and cache it using the Room DB via MVVM pattern. We are using the [TMDB API's](https://www.themoviedb.org/) for this purpose. 
+
+![Banner Image](https://github.com/clint22/tmdb_sample_project/blob/master/previews/tmdb_banner.png)
+
+# How to build on your environment
+Add your [TMDB](https://www.themoviedb.org/) API key in local.properties. 
+
+```API_KEY=YOUR_API_KEY```
+
+# Tech stack and open source libraries 
+
+* Minimum SDK level 21
+* 100% Kotlin based + [Coroutines](https://developer.android.com/kotlin/coroutines) based + [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) for asynchronous.
+* [Dagger Hilt](https://developer.android.com/training/dependency-injection/hilt-android) for dependency injection.
+* [Room persistence](https://developer.android.com/training/data-storage/room)
+* [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel?gclsrc=ds&gclid=COSn4ZOYx_ICFRYUjgodNmoF8w&gclsrc=ds)
+* [MVVM Architecture](https://developer.android.com/jetpack/guide?gclsrc=ds&gclsrc=ds&gclid=CNTt9qKYx_ICFVEmjgodzOQPvg)
+* [Retrofit](https://square.github.io/retrofit/) Networking library
+* [Timber](https://github.com/JakeWharton/timber) Logging library 
+* [LottieFiles](https://lottiefiles.com/) Animations