Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
stephan-gh committed Sep 25, 2016
1 parent fea9464 commit c566d40
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,7 @@ licenser is a simple license header manager for Gradle. It can automatically ens
## Features
- Apply pre-defined license header in a file to the source files of the source sets
- Apply license header only to certain files (include/exclude possible)
- Insert a blank new line after the license header
- Select the source sets to apply the license headers to
- Choose from a pre-defined set of license header styles and assign them to certain extensions
- **Maybe Soon(TM)**: Define custom license header styles
- Apply special license headers to matching files
- Support for Android projects

## Usage
Expand Down Expand Up @@ -60,6 +57,21 @@ The plugin can be configured using the `license` extension on the project.
exclude '**/*.properties' // Apply license header NOT to properties files
}
```
- **Apply special license header to some matching files:**

```gradle
license {
// Apply special license header to one source file
matching('**/ThirdPartyLibrary.java') {
header = file('THIRDPARTY-LICENSE.txt')
}
// Apply special license header to matching source files
matching(includes: ['**/thirdpartylibrary/**', '**/ThirdPartyLibrary.java']) {
header = file('THIRDPARTY-LICENSE.txt')
}
}
```
- **Manage file extension to license header styles:**

```gradle
Expand Down

0 comments on commit c566d40

Please sign in to comment.