Merge remote-tracking branch 'origin/master'

README.md

@@ -0,0 +1,42 @@
+# Road status search
+
+## Requirements
+
+ - Minimum android SDK version 24
+ - Permissions : Internet
+
+## How to run
+ 
+ - Add you API_key and Application_id in the keys.xml in the resources directory
+ - Build the project via android studio and launch on a device or emulator
+ - Build the project and launch the UI test from the in the configuration options
+
+## Features
+
+ - Search the trasport api for current road status
+ - get Road Id, Road Status and Description from the search
+ - Data binding into the view model to hold data even after the activity has been destroyed by android
+ - SOLID coding priciples applied to keep code clean and easy to read 
+
+## Architectural Pattern
+
+MVVM - Model View Viewmodel
+
+## Jetpack
+
+* [AndroidX](https://developer.android.com/jetpack)
+
+## UI test
+
+### Test case One
+ - UI test for searching road status via the app
+ 
+## 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
+
+
+## Authors
+
+* **Haider Malik** - *Android Developer*