diff --git a/README.md b/README.md new file mode 100644 index 0000000..e0b7623 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# Easy CC + +A simple and incredibily lightweight currency converter. +I created this app for private use but when it prevented me getting ripped off in Bali. I realised this can benefit many people. +This app also includes a home-screen widget which displays the current currency rate +of your choice, which updates every 3 hours. + +## Requirements + +Minimum android SDK version 21, Android 5.0.0 (Lollipop) +Permissions : Internet, Network State + +## Features + + - Simple convert as you type + - 155 different currencies to choose from (inc. Bitcoin) + - Simple homescreen widget of your conversion pair choice + + +## Architectural Pattern + +MVVM - Model View Viewmodel +SOLID coding + +## Jetpack + +* [AndroidX](https://developer.android.com/jetpack) + +## Unit tests + + - Respository Unit test (Networkings) + - Repository Unit test (Storage) + - Mainactivity viewmodel test + - Widget configure viewmodel test + + ## Integration tests + +### Test case one + - MainActivity UI test + +## 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 +* [Mokito](https://github.com/mockito/mockito) - Most popular Mocking framework for unit tests written in Java +* [Mokito-kotlin](https://github.com/nhaarman/mockito-kotlin) - Using Mockito with Kotlin + +## Submitted by + +* **Haider Malik** - *Android Developer* + + +