Add README and previews

README.md

@@ -1,2 +1,75 @@
-# Pokedex
-Android Pokedex using Dagger Hilt, Motion, Couroutines, Jetpack (Room, ViewModel, LiveData) based on MVVM architecture
+<h1 align="center">Pokedex</h1>
+
+<p align="center">
+  <a href="https://opensource.org/licenses/Apache-2.0"><img alt="License" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/></a>
+  <a href="https://android-arsenal.com/api?level=21"><img alt="API" src="https://img.shields.io/badge/API-21%2B-brightgreen.svg?style=flat"/></a>
+  <a href="https://github.com/skydoves"><img alt="Profile" src="https://skydoves.github.io/badges/skydoves.svg"/></a> 
+</p>
+
+<p align="center">  
+Pokedex is a small demo application based on modern Android application tech-stacks and MVVM architecture.<br>This project is for focusing especially on the new library Dagger-Hilt of implementing dependency injection.<br>
+Also fetching data from the network and integrating persisted data in the database via repository pattern.
+</p>
+</br>
+
+<p align="center">
+<img src="/previews/screenshot.png"/>
+</p>
+
+## Download
+Go to the [Releases](https://github.com/skydoves/Pokedex/releases) to download the lastest APK.
+
+
+<img src="/previews/preview.gif" align="right" width="32%"/>
+
+## Tech stack & Open-source libraries
+- Minimum SDK level 21
+- [Kotlin](https://kotlinlang.org/) based + [Coroutines](https://github.com/Kotlin/kotlinx.coroutines) for asynchronous.
+- Dagger-Hilt (alpha) for dependency injection.
+- JetPack
+  - LiveData - notify domain layer data to views.
+  - Lifecycle - dispose of observing data when lifecycle state changes.
+  - ViewModel - UI related data holder, lifecycle aware.
+  - Room Persistence - construct a database using the abstract layer.
+- Architecture
+  - MVVM Architecture (View - DataBinding - ViewModel - Model)
+  - Repository pattern
+- [Retrofit2 & OkHttp3](https://github.com/square/retrofit) - construct the REST APIs and paging network data.
+- [Sandwich](https://github.com/skydoves/Sandwich) - construct lightweight http API response and handling error responses.
+- [Moshi](https://github.com/square/moshi/) - A modern JSON library for Kotlin and Java.
+- [Glide](https://github.com/bumptech/glide) - loading images.
+- [TransformationLayout](https://github.com/skydoves/transformationlayout) - implementing transformation motion animations.
+- [WhatIf](https://github.com/skydoves/whatif) - checking nullable object and empty collections more fluently.
+- [Timber](https://github.com/JakeWharton/timber) - logging.
+- [Material-Components](https://github.com/material-components/material-components-android) - Material design components like ripple animation, cardView.
+- Custom Views
+  - [Rainbow](https://github.com/skydoves/rainbow) - An easy way to apply gradations and tinting for Android.
+  - [AndroidRibbon](https://github.com/skydoves/androidribbon) - A simple way to implement a  beautiful ribbon with the shimmering on Android.
+  - [ProgressView](https://github.com/skydoves/progressview) - 🌊 A polished and flexible ProgressView, fully customizable with animations.
+
+## Architecture
+Pokedex is based on MVVM architecture and a repository pattern.
+
+![architecture](https://user-images.githubusercontent.com/24237865/77502018-f7d36000-6e9c-11ea-92b0-1097240c8689.png)
+
+
+## Find this repository useful? :heart:
+Support it by joining __[stargazers](https://github.com/skydoves/Pokedex/stargazers)__ for this repository. :star: <br>
+And __[follow](https://github.com/skydoves)__ me for my next creations! 🤩
+
+# License
+```xml
+Designed and developed by 2020 skydoves (Jaewoong Eum)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```