From 490bf668496e359c272a9951bc08f369f81d87da Mon Sep 17 00:00:00 2001
From: Braydon <xcoolmanxx@gmail.com>
Date: Thu, 3 Aug 2023 06:46:07 -0400
Subject: [PATCH] Update README.md

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 866047a..a5a13bb 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,32 @@
 # maven-git-versioning
 
 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.
\ No newline at end of file
+-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>
+```
\ No newline at end of file