diff --git a/README.md b/README.md new file mode 100644 index 0000000..b5d6e67 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# Sliide-news-reader + +Login to Sliide news reader and see content based on user role + +## Requirements + + - Minimum android SDK version 26 + - Permissions : Internet + +## Features + + - Login Screen + - User roles (Premium & Basic) + - Slide images through multiple images on content (if available) + - Open links to the new article by clicking the title + +## Architectural Pattern + +MVVM - Model View Viewmodel + +## Jetpack + +* [AndroidX](https://developer.android.com/jetpack) + +## Unit tests + +### Test case one + - Testing of room database queries + +### Test case two + - UI test for authentification testing during login procedure + +## Built With + +* [Kodein](https://github.com/Kodein-Framework/Kodein-DI) - Painless Kotlin Dependency Injection +* [Retrofit](https://github.com/square/retrofit) - Type-safe HTTP client for Android and Java by Square, Inc +* [Room Persistence Library](https://developer.android.com/topic/libraries/architecture/room) - The library helps you create a cache of your app's data on a device that's running your app +* [Picasso](https://square.github.io/picasso/) - A powerful image downloading and caching library for Android + + +## Authors + +* **Haider Malik** - *Android Developer*