Improve readme

Drjacky · Jun 25, 2020 · ae1f681 · ae1f681
1 parent 01f9d95
commit ae1f681
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,23 @@
-# MVVM design pattern with the Clean Architecture approach
+# Android MVVM + Clean Architecture
 
-## ⚠️[Not Deprecated But]⚠️
-Please take a look into this Android Template as well: https://github.com/Drjacky/MVVMTemplate
+A simple Android application to show the MVVM design pattern usage with following Clean Architecture approach. 
+
+## Features 🕹
+
+- 100% Kotlin-only.
+- Following Clean Architecture approach.
+- Following MVVM Architectural Design Pattern.
+- Using Pagination.
+- Simplest Adapter Ever (based on this [workaround](https://proandroiddev.com/the-best-android-recycler-adapter-youve-ever-seen-probably-177e25279a28)).
+
+## Under Development 🚧
+
+- Some minor improvements.
+- *Please take a look into this [Android Template](https://github.com/Drjacky/MVVMTemplate) instead*
+
+## Contributing 🤝
+
+Feel free to open a issue or submit a pull request for any bugs/improvements.
+
+## Result 📺
+![Screenshot](https://raw.githubusercontent.com/Drjacky/MVVM/master/list.png)
diff --git a/list.png b/list.png