Skip to content

Update readme #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 22, 2017
Merged

Update readme #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,19 @@ Request additional libraries through issues. Pull requests are welcome.
[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-android--proguard--snippets-brightgreen.svg?style=flat)](https://android-arsenal.com/details/3/1242)

### Usage

#### 1. Include the proguard files in your project
First of all, add the repository as a git submodule (or just copy the proguard files in your project).

#### 2. Integrate the proguard files in your project
```groovy
android {
buildTypes {
release {
minifyEnabled true
// Library specific proguard files
proguardFile 'proguard-google-play-services.pro'
proguardFile 'proguard-gson.pro'
proguardFile '$PATH_TO_THE_PROGUARD_FILES/proguard-google-play-services.pro'
proguardFile '$PATH_TO_THE_PROGUARD_FILES/proguard-gson.pro'
...
// Default proguard files & project app specific rules,
// see examples folder for more information
Expand All @@ -32,8 +37,7 @@ android {

Instead of declaring each configuration file manually, you could also store them in a seperate directory and include them all at once:
```groovy
FileCollection proGuardFileCollection = files { file('./proguard').listFiles() }
proguardFiles(proGuardFileCollection)
proguardFiles fileTree(dir: "$PATH_TO_THE_PROGUARD_FILES", include: ["*.pro"]).asList().toArray()
```

### Libraries
Expand Down