From 77ee9f20683e6eb15edab5dc932728476de7c863 Mon Sep 17 00:00:00 2001 From: Jeremy Landis Date: Sat, 27 May 2023 14:30:53 -0400 Subject: [PATCH] [ci] Add quick links to readme 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. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 1a57b0d8d..bbac4ca4b 100755 --- a/README.md +++ b/README.md @@ -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/**```