chore: add README.md, LICENSE and CONTRIBUTING.md

Author: KryptKode

CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# How to Contribute
+
+We encourage you to participate in this open source project. We love pull requests, bug reports, ideas, (security) code reviews or any kind of positive contribution.
+
+However, first of all, make sure that you have correctly configured the [development environment](https://github.com/VMadalin/kotlin-sample-app#environment-setup).
+
+## 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.
+
+After that create your [pull request](https://github.com/VMadalin/kotlin-sample-app/compare) and complete the template structure adding any information that you consider relevant, to make it easier to identify these changes. It is important user names of commits description.
+
+## Code quality
+
+Once the pull request is created, make sure that it passes the different static analysis checks and tests. Otherwise review the errors in the build and make the necessary changes to correct it.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Boisney Philippe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,32 @@
+# Android Multi-Module Template
+
+A template for bootstrapping a multi-module android project. It demonstrates clean architecture and has a navigation module based on [this](https://github.com/PhilippeBoisney/android-multi-modules-navigation-demo)
+
+## Top things to learn here
+
+- Multi-module clean architecture
+- Kotlin coroutines with Flow
+- Dependency injection with Dagger-Hilt
+- Unit testing
+- View abstracted from Fragment
+- API request with Retrofit
+- CI/CD with Github actions
+- Code lint check with [Ktlint](https://github.com/pinterest/ktlint) using a [gradle plugin](https://github.com/JLLeitschuh/ktlint-gradle)
+- Static code analysis with [detekt](https://github.com/detekt/detekt)
+- Dependency management with [buildSrc](https://gradle.org/kotlin/)  (Kotlin DSL)
+- Dependency updates with [buildSrcVersions](https://jmfayard.github.io/refreshVersions/)
+
+## Libraries
+
+- [Material Components](https://github.com/material-components/material-components-android/)
+- [Constraint Layout](https://developer.android.com/reference/android/support/constraint/ConstraintLayout)
+- [Retrofit](http://square.github.io/retrofit) for REST api communication
+- [Mockk](https://github.com/mockk/mockk) for mocking in tests
+- [Dagger2](https://github.com/google/dagger) for dependency injection
+- [Kotlin Flow](https://kotlinlang.org/docs/reference/coroutines/flow.html) for concurrency
+- [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) & [LiveData](https://developer.android.com/topic/libraries/architecture/livedata)
+- [Navigation Architecture Component](https://developer.android.com/guide/navigation/navigation-getting-started)
+- [ViewBinding](https://developer.android.com/topic/libraries/view-binding)
+- [Kotlin Delegates](https://kotlinlang.org/docs/reference/delegated-properties.html)
+- [Ktlint gradle plugin](https://github.com/JLLeitschuh/ktlint-gradle) for code lint checks
+- [Detekt](https://github.com/detekt/detekt) for static code analysis