Update README.md

This commit is contained in:
Braydon 2023-08-03 06:49:23 -04:00
parent 490bf66849
commit 42821295b1

@ -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. -dev-{gitDepth}-{gitHash}", allowing you to gain valuable insights into the exact commit from which each jar was built.
# Usage # Usage
```xml 1. Add the plugin to your pom.xml:
<build> ```xml
<plugins> <build>
<plugin> <plugins>
<groupId>me.braydon</groupId> <plugin>
<artifactId>git-versioning-maven-plugin</artifactId> <groupId>me.braydon</groupId>
<version>1.0</version> <artifactId>git-versioning-maven-plugin</artifactId>
<executions> <version>1.0</version>
<execution> <executions>
<phase>compile</phase> <execution>
<goals> <phase>compile</phase>
<goal>versioning</goal> <goals>
</goals> <goal>versioning</goal>
</execution> </goals>
</executions> </execution>
</plugin> </executions>
</plugins> </plugin>
</build> </plugins>
</build>
<pluginRepositories>
<pluginRepository> <pluginRepositories>
<id>rainnny-repo-public</id> <pluginRepository>
<url>https://maven.rainnny.club/public</url> <id>rainnny-repo-public</id>
</pluginRepository> <url>https://maven.rainnny.club/public</url>
</pluginRepositories> </pluginRepository>
``` </pluginRepositories>
```
2. Build your project with `mvn package` (or `mvn git-versioning:versioning` if you just want to see data)