aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6cd4864..a31245d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,19 @@
# KotlinForForge
Makes Kotlin forge-friendly.
+
+To implement in your project, add the following to your build.gradle:
+```
+repositories {
+ maven {
+ name = "kotlinforforge"
+ url = "https://cdn.jsdelivr.net/gh/thedarkcolour/KotlinForForge@master/"
+ }
+}
+
+dependencies {
+ implementation 'thedarkcolour:kotlinforforge:0.1.14'
+}
+```
+Then, in your mods.toml file, change modLoader to "kotlinforforge".
+
+Currently, this mod allows you to have @Mod object declarations and @Mod.EventBusSubscriber declarations.