Update README file and add CONTRIBUTING and CODEOWNERS files

Author: MostafaGazar

CODEOWNERS

@@ -0,0 +1 @@
+*       @MostafaGazar

CONTRIBUTING.md

@@ -0,0 +1,53 @@
+How to Contribute
+-----------------
+We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
+
+Getting Started
+---------------
+We use [gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) so instead of a single `master` branch, we use two branches to record the history of the project. The `master` branch stores the official release history, and the `develop` branch serves as an integration branch for features. It's also convenient to tag all commits in the master branch with a version number.
+
+Workflow
+--------
+If you would like to contribute to this project, please:
+- Pick an [issue](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android/issues) to work on or create a [proposal](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android#feature-proposals) for a new feature.
+- Fork this project.
+- Create your feature branch based off the `develop` branch.
+- Create a pull request to get your worked reviewed and merged back into the upstream `develop` branch.
+
+Please include screenshots of your app changes and write down the test scenarios you followed to verify that your code works.
+
+Feature proposals
+-----------------
+Please create an issue, label it as a `feature proposal` and follow the following template:
+```markdown
+# Proposal: [your title here]
+
+## Summary
+{Also include any designs or wireframes here}
+
+## Rationale
+{First reason for why we should consider this proposal}
+{Second reason for why we should consider this proposal}
+{etc}
+
+## Scope
+
+## Important Notes
+
+## Open Questions
+```
+
+How to get unstuck
+------------------
+We have an active Slack community that you can reach out to for more information or just to chat with anyone. Check out the [<img src="https://upload.wikimedia.org/wikipedia/commons/7/76/Slack_Icon.png" alt="Slack Channel" width="15px"/> SED Android app development](https://softwaredaily.slack.com/app_redirect?channel=sed_app_android) slack channel. 
+
+Also checkout the [Open Source Guide](https://softwareengineeringdaily.github.io/).
+
+Code reviews
+------------
+All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests.
+
+Community Guidelines
+--------------------
+- Be considerate, kind, constructive, and helpful.
+- Do not engage in demeaning, discriminatory, harassing, or hateful speech, and imagery.

README.md

@@ -1,48 +1,80 @@
+# SEDaily-Android
 
 [![logo](https://i.imgur.com/3OtP3p8.png)](https://softwareengineeringdaily.com/)
 
-[![Build Status](https://travis-ci.org/SoftwareEngineeringDaily/SEDaily-Android.svg?branch=develop)](https://travis-ci.org/SoftwareEngineeringDaily/SEDaily-Android)
-[![codecov](https://codecov.io/gh/SoftwareEngineeringDaily/SEDaily-Android/branch/develop/graph/badge.svg)](https://codecov.io/gh/SoftwareEngineeringDaily/SEDaily-Android)
-[![codebeat badge](https://codebeat.co/badges/a5d6976a-9163-491b-8618-0673b703529a)](https://codebeat.co/projects/github-com-softwareengineeringdaily-sedaily-android-develop)
-[![Help Contribute to Open Source](https://www.codetriage.com/softwareengineeringdaily/sedaily-android/badges/users.svg)](https://www.codetriage.com/softwareengineeringdaily/sedaily-android)
+A player for the Software Engineering Daily Podcast
 
-# SEDaily-Android
+Getting Started
+---------------
+The app has 2 build types: debug and release with minor differences between both builds. [`Stetho`](http://facebook.github.io/stetho/) for example is only enabled for debug builds. And [`Timber`](https://github.com/JakeWharton/timber) to log warnings and errors as Crashlytics non-fatal crashes in release builds.
 
-A player for the Software Engineering Daily Podcast
+We also use different app icons for debug and release builds and you can keep both builds on your device and run them side by side.
+![](screenshots/debug-release-icons.png)
 
-## Getting Started
+The app is 100% [Kotlin](http://kotlinlang.org) and we think it is better to keep it this way.
 
-### Cloning the Project
+We use [`Koin`](https://insert-koin.io) which is a lightweight dependency injection framework to manage all dependencies. And [`Kotlin Coroutines`](https://kotlinlang.org/docs/reference/coroutines-overview.html) for asynchronous work. We also use `Kotlin Coroutines` with [`Room`](https://developer.android.com/topic/libraries/architecture/room) and [`Retrofit`](https://square.github.io/retrofit/).
+
+Cloning the Project
+-------------------
 ```sh
 $ git clone https://github.com/SoftwareEngineeringDaily/SEDaily-Android.git
 $ cd SEDaily-Android
 ```
 
-### Setting up Firebase
-1. Go to the [Firebase website](https://firebase.google.com/) and create an account if you do not already have one
-2. Create a new project on the Firebase dashboard
-3. Add a new Android app in the Firebase Dashboard.
-4. Set the package name to `com.koalatea.thehollidayinn.softwareengineeringdaily.debug`
-5. Download `google-services.json` and place it in `/app/`
-
-
-Compile the project with Gradle using
+And then compile the project with Gradle using
 ```sh
 ./gradlew build
 ```
 
+Screenshots
+-----------
+![](screenshots/1.png)
+![](screenshots/2.png)
+![](screenshots/3.png)
+![](screenshots/4.png)
 
-## Built With
+Libraries Used
+--------------
+* [Foundation][0] - Components for core system capabilities, and Kotlin extensions.
+  * [AppCompat][1] - Degrade gracefully on older versions of Android.
+  * [Android KTX][2] - Write more concise, idiomatic Kotlin code and helper functions for easy integration with coroutines.
+  * [exoplayer][6] to manage the media playback.
+* [Architecture][10] - A collection of libraries that help design robust, testable, and maintainable apps.
+  * [Lifecycles][12] - Create a UI that automatically responds to lifecycle events.
+  * [LiveData][13] - Build data objects that notify views when the underlying data changes.
+  * [Navigation][14] - Handle everything needed for in-app navigation.
+  * [Room][16] - Access app's SQLite database with in-app objects and compile-time checks.
+  * [ViewModel][17] - Store UI-related data that isn't destroyed on app rotations.
+* Third party
+  * [Glide][90] for image loading.
+  * [Epoxy][3] for building complex screens in a RecyclerView.
+  * [Koin][4] a lightweight dependency injection framework to manage all dependencies.
+  * [Retrofit][5] a type-safe HTTP client for Android and Java.
+  * [Timber][7] to log warnings and errors as Crashlytics non-fatal crashes in release builds.
+  * [Kotlin Coroutines][91] for managing background threads with simplified code and reducing needs for callbacks.
 
-* [Android](https://www.android.com/)
-* [Gradle](https://gradle.org/)
-* [Firebase](https://firebase.google.com/)
-* [Material UI Chip Input](https://github.com/TeamWertarbyte/material-ui-chip-input)
-* [ReactiveX](http://reactivex.io/)
-* [Leak Canary](https://github.com/square/leakcanary)
-* [OkHttp](https://github.com/square/okhttp)
-* [Retrofit](https://github.com/square/retrofit)
+[0]: https://developer.android.com/jetpack/components
+[1]: https://developer.android.com/topic/libraries/support-library/packages#v7-appcompat
+[2]: https://developer.android.com/kotlin/ktx
+[3]: https://github.com/airbnb/epoxy
+[4]: https://insert-koin.io
+[5]: https://square.github.io/retrofit/
+[6]: https://exoplayer.dev
+[7]: https://github.com/JakeWharton/timber
+[10]: https://developer.android.com/jetpack/arch/
+[12]: https://developer.android.com/topic/libraries/architecture/lifecycle
+[13]: https://developer.android.com/topic/libraries/architecture/livedata
+[14]: https://developer.android.com/topic/libraries/architecture/navigation/
+[16]: https://developer.android.com/topic/libraries/architecture/room
+[17]: https://developer.android.com/topic/libraries/architecture/viewmodel
+[90]: https://bumptech.github.io/glide/
+[91]: https://kotlinlang.org/docs/reference/coroutines-overview.html
 
-## Contributing
+Upcoming features
+-----------------
+Interested in seeing a particular feature implemented in this app? Please open a new [issue](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android/issues) with a [feature proposal](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android#feature-proposals).
 
-## License
+Contributing
+------------
+Checkout [CONTRIBUTING.md](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android/CONTRIBUTING.md) for details.