aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorthedarkcolour <30441001+thedarkcolour@users.noreply.github.com>2019-11-11 14:47:37 -0800
committerthedarkcolour <30441001+thedarkcolour@users.noreply.github.com>2019-11-11 14:47:37 -0800
commitbf11f1cb96cfeb98a21025459f24f235ff06cd42 (patch)
tree1f2ba123cb23ee764f83a509152892a580b74678 /README.md
parenteff6ca9a8dc3d8844443cbba79a535d39d2a2405 (diff)
downloadKotlinForForge-bf11f1cb96cfeb98a21025459f24f235ff06cd42.tar.gz
KotlinForForge-bf11f1cb96cfeb98a21025459f24f235ff06cd42.tar.bz2
KotlinForForge-bf11f1cb96cfeb98a21025459f24f235ff06cd42.zip
Adding files
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/README.md b/README.md
index 7a84c65..76776cf 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,9 @@
-I am no longer working on this because Kottle exists.
-
-
# KotlinForForge
-Makes Kotlin forge-friendly.
+Makes Kotlin forge-friendly by doing the following:
+- Provides the Kotlin libraries.
+- Provides `KotlinLanguageProvider` to allow usage of object declarations as @Mod targets.
+- Provides `AutoKotlinEventBusSubscriber` to allow usage of object declarations as @Mod.EventBusSubscriber targets.
+- Provides `KtDeferredRegister` as an alternative to `DeferredRegister` that returns non-null values
To implement in your project, add the following to your build.gradle:
```groovy