From b0b45723b2c1eaf4230f302360b621a9618643da Mon Sep 17 00:00:00 2001
From: Liam <liam@fascinated.cc>
Date: Wed, 17 Apr 2024 22:07:47 +0100
Subject: [PATCH] readme

---
 .gitea/workflows/publish.yml |  6 +++++-
 README.md                    | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/.gitea/workflows/publish.yml b/.gitea/workflows/publish.yml
index 5d84a7a..62e46ba 100644
--- a/.gitea/workflows/publish.yml
+++ b/.gitea/workflows/publish.yml
@@ -1,7 +1,11 @@
 name: Publish package to my Maven Repository
 on:
   push:
-    branches: ["master"]
+    branches: [master]
+    paths-ignore:
+      - .gitignore
+      - README.md
+      - LICENSE
 
 jobs:
   docker:
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..85c6eaf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Minecraft Utilities - Java Library
+
+The Java library for the Minecraft Utilities API.
+
+## Usage
+
+Maven:
+
+```xml
+<repositories>
+    <repository>
+        <id>fascinated-repo-public</id>
+        <name>Fascinated's Repository</name>
+        <url>https://repo.fascinated.cc/public</url>
+    </repository>
+</repositories>
+
+<dependencies>
+    <dependency>
+        <groupId>xyz.mcutils</groupId>
+        <artifactId>mcutils-java-library</artifactId>
+        <version>1.1</version>
+    </dependency>
+</dependencies>
+```
+
+Usage:
+
+```java
+public class Main {
+    public static void main(String[] args) {
+        System.out.println(McUtilsAPI.getPlayer("Notch"));
+    }
+}
+```
\ No newline at end of file