diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8289429..d9cae7d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ We use [gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/git 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. +- 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/blob/master/CONTRIBUTING.md#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. diff --git a/README.md b/README.md index 4140e66..916a74d 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,10 @@ 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. 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) + The app is 100% [Kotlin](http://kotlinlang.org) and we think it is better to keep it this way. 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/). @@ -29,10 +31,7 @@ And then compile the project with Gradle using Screenshots ----------- -![](screenshots/1.png) -![](screenshots/2.png) -![](screenshots/3.png) -![](screenshots/4.png) +![App screenshots](screenshots/app_screenshots.png) Libraries Used -------------- @@ -73,7 +72,7 @@ Libraries Used 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). +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/blob/master/CONTRIBUTING.md#feature-proposals). Contributing ------------ diff --git a/screenshots/1.png b/screenshots/1.png deleted file mode 100644 index ff69ab4..0000000 Binary files a/screenshots/1.png and /dev/null differ diff --git a/screenshots/2.png b/screenshots/2.png deleted file mode 100644 index fbc667e..0000000 Binary files a/screenshots/2.png and /dev/null differ diff --git a/screenshots/3.png b/screenshots/3.png deleted file mode 100644 index de0ef7f..0000000 Binary files a/screenshots/3.png and /dev/null differ diff --git a/screenshots/4.png b/screenshots/4.png deleted file mode 100644 index d38032b..0000000 Binary files a/screenshots/4.png and /dev/null differ diff --git a/screenshots/app_screenshots.png b/screenshots/app_screenshots.png new file mode 100644 index 0000000..6de27f0 Binary files /dev/null and b/screenshots/app_screenshots.png differ