Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arthur3486 committed May 4, 2019
1 parent 08ca634 commit 332831f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ before_install:
- chmod +x gradlew

script:
- ./gradlew clean build check
- ./gradlew :mvvm:clean :mvvm:build :mvvm:check
- ./gradlew :mvvm-dagger:clean :mvvm-dagger:build :mvvm-dagger:check
- ./gradlew :mvvm-navigation:clean :mvvm-navigation:build :mvvm-navigation:check
- ./gradlew :mvvm-navigation-dagger:clean :mvvm-navigation-dagger:build :mvvm-navigation-dagger:check

after_failure: "cat $TRAVIS_BUILD_DIR/app/build/outputs/lint-results-debug.xml"
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Platform](https://img.shields.io/badge/platform-Android-green.svg)](http://developer.android.com/index.html)
![](https://img.shields.io/badge/API-21%2B-green.svg?style=flat)
![](https://travis-ci.org/arthur3486/android-mvvm.svg?branch=master)

## Contents

Expand All @@ -19,6 +20,7 @@
* [Dagger Based Implementation](#dagger-based-implementation)
* [Navigation Component Based Implementation](#navigation-component-based-implementation)
* [Navigation Component and Dagger Based Implementation](#navigation-component-and-dagger-based-implementation)
* [Compilation](#compilation)
* [Contribution](#contribution)
* [Hall of Fame](#hall-of-fame)
* [License](#license)
Expand Down Expand Up @@ -613,6 +615,16 @@ Shares many implementation-specific aspects with the previously described implem

> ***See: [`MvvmActivity`](https://github.com/arthur3486/android-mvvm/blob/master/mvvm-navigation-dagger/src/main/java/com/arthurivanets/mvvm/navigation/dagger/MvvmActivity.kt), [`MvvmFragment`](https://github.com/arthur3486/android-mvvm/blob/master/mvvm-navigation-dagger/src/main/java/com/arthurivanets/mvvm/navigation/dagger/MvvmFragment.kt)***
## Compilation

In order to compile the [`app`](https://github.com/arthur3486/android-mvvm/tree/master/app/src/main) module you need to obtain the `PUBLIC_API_KEY` and `PRIVATE_API_KEY` from the [`Marvel API`](https://developer.marvel.com/) portal, which should be saved in either global `gradle.properties` file or the project-specific one thereafter.

***gradle.properties***
````groovy
marvelApiPublicKey=PUBLIC_API_KEY
marvelApiPrivateKey=PRIVATE_API_KEY
````

## Contribution

See the [CONTRIBUTING.md](CONTRIBUTING.md) file.
Expand Down

0 comments on commit 332831f

Please sign in to comment.