summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/README.md b/README.md
index 6da1f2d..4b31975 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,16 @@
-# KBackup-Fabric
-A simple backup plugin for fabric Minecraft server.
+# Fabric Example Mod
+
+## Setup
+
+1. Edit build.gradle and mod.json to suit your needs.
+ * The "mixins" object can be removed from mod.json if you do not need to use mixins.
+ * Please replace all occurences of "modid" with your own mod ID - sometimes, a different string may also suffice.
+2. Run the following command:
+
+```
+./gradlew setup idea
+```
+
+## License
+
+This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.