From 45a6fa374739189e6d070066f620a3bc16568616 Mon Sep 17 00:00:00 2001
From: Zontreck <tarapiccari@gmail.com>
Date: Tue, 27 Sep 2022 02:52:25 -0700
Subject: [PATCH] Publish readme file

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b27bee6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+HOW TO BUILD
+=========
+
+On your platform of choice
+```
+gradlew clean jar
+```
+
+
+ROADMAP
+=========
+
+There is not much on the roadmap for the mod except to maintain the code for future versions.
+
+The following is the possible roadmap:
+
+1. Create a spigot plugin variant.
+2. Explore possibly making a quilt mod variant.
\ No newline at end of file