Skip to content

Commit

Permalink
[ci] Add quick links to readme
Browse files Browse the repository at this point in the history
makes it easier than trying to find in documentation and the header types isn't linked from documentation.  For those that need quick reference, I generally list both these in pom usage.  So it only makes sense to make it up front and clear.
  • Loading branch information
hazendaz authored and mathieucarbou committed May 27, 2023
1 parent 902b6c3 commit 77ee9f2
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
# LIcense Maven Plugin

- __Build Status:__ [![Java CI](https://github.com/mathieucarbou/license-maven-plugin/actions/workflows/ci.yaml/badge.svg)](https://github.com/mathieucarbou/license-maven-plugin/actions/workflows/ci.yaml)
- __Issues:__ https://github.com/mathieucarbou/license-maven-plugin/issues
- __Documentation:__ https://mycila.carbou.me/license-maven-plugin/
- __License:__ [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)

## Quick Links ##

- [Default Excludes](https://github.com/mathieucarbou/license-maven-plugin/blob/master/license-maven-plugin/src/main/java/com/mycila/maven/plugin/license/Default.java)
- [Header Types](https://github.com/mathieucarbou/license-maven-plugin/blob/master/license-maven-plugin/src/main/java/com/mycila/maven/plugin/license/header/HeaderType.java)

## Quick Tip ##

Often necessary to exclude a number of files that would otherwise grow the exclusion list on setup and do not fit with the default exclusions provided by this plugin. To exclude complete sections, please into a special folder to do exactly that.

```**/unlicensed/**```

0 comments on commit 77ee9f2

Please sign in to comment.