Update README.md

README.md

@@ -2,3 +2,31 @@
 
 This plugin seamlessly converts standard "-SNAPSHOT" versions into a more descriptive format, "
 -dev-{gitDepth}-{gitHash}", allowing you to gain valuable insights into the exact commit from which each jar was built.
+
+# Usage
+```xml
+<build>
+    <plugins>
+        <plugin>
+            <groupId>me.braydon</groupId>
+            <artifactId>git-versioning-maven-plugin</artifactId>
+            <version>1.0</version>
+            <executions>
+                <execution>
+                    <phase>compile</phase>
+                    <goals>
+                        <goal>versioning</goal>
+                    </goals>
+                </execution>
+            </executions>
+        </plugin>
+    </plugins>
+</build>
+
+<pluginRepositories>
+    <pluginRepository>
+        <id>rainnny-repo-public</id>
+        <url>https://maven.rainnny.club/public</url>
+    </pluginRepository>
+</pluginRepositories>
+```