diff --git a/README.md b/README.md index a5a13bb..8ee182d 100644 --- a/README.md +++ b/README.md @@ -4,29 +4,31 @@ This plugin seamlessly converts standard "-SNAPSHOT" versions into a more descri -dev-{gitDepth}-{gitHash}", allowing you to gain valuable insights into the exact commit from which each jar was built. # Usage -```xml - - - - me.braydon - git-versioning-maven-plugin - 1.0 - - - compile - - versioning - - - - - - - - - - rainnny-repo-public - https://maven.rainnny.club/public - - -``` \ No newline at end of file +1. Add the plugin to your pom.xml: + ```xml + + + + me.braydon + git-versioning-maven-plugin + 1.0 + + + compile + + versioning + + + + + + + + + + rainnny-repo-public + https://maven.rainnny.club/public + + + ``` +2. Build your project with `mvn package` (or `mvn git-versioning:versioning` if you just want to see data) \ No newline at end of file