https://github.com/shyiko/usage-maven-plugin

Maven Plugin for printing project Usage information
https://github.com/shyiko/usage-maven-plugin

Last synced: 3 months ago
JSON representation

Maven Plugin for printing project Usage information

• Host: GitHub
• URL: https://github.com/shyiko/usage-maven-plugin
• Owner: shyiko
• Created: 2012-07-16T22:53:16.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2012-07-18T15:16:23.000Z (almost 13 years ago)
• Last Synced: 2025-01-21T03:25:15.652Z (5 months ago)
• Language: Java
• Size: 102 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
#usage-maven-plugin#

Maven 3+ Plugin for printing project Usage information.

Usage

---------------

Add following snippet to your pom.xml (change <usage/> section) and hit "mvn"

    

        

            

                com.github.shyiko.usage-maven-plugin

                usage-maven-plugin

                1.0.0

                

                    

                        # deploy snapshot to Sonatype Nexus Snapshots

                        mvn clean deploy

                        # deploy release to Sonatype Nexus Staging

                        mvn clean release:clean release:prepare release:perform

                    

                

            

        

        

            

                com.github.shyiko.usage-maven-plugin

                usage-maven-plugin

                1.0.0

            

        

    

>NOTE: registration of usage-maven-plugin as extension is not strictly required, but it frees from enabling non-recursive mode (that is, by using -N flag) and explicit definition of <defaultGoal>usage:show</defaultGoal>. So, it's usually as good thing.

Result is shown below:

            

![](http://i.minus.com/jbqyE1Al0ObBgf.png)

License

---------------

[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)