From de10f717665789183e1529900fb718bd0fcbc416 Mon Sep 17 00:00:00 2001 From: Shadowfacts Date: Sat, 6 Aug 2016 10:40:14 -0400 Subject: [PATCH] Add README.md --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a45e188 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Forgelin +Fork of [Emberwalker's Forgelin](https://github.com/Emberwalker/Forgelin) with some sprinkles on top. + +## Additions +- Extensions for Minecraft/Forge code. See them in the [extensions package](https://github.com/shadowfacts/Forgelin/tree/master/src/main/kotlin/net/shadowfacts/forgelin/extensions/). + +## Usage +```groovy +repositories { + maven { + url "http://mvn.rx14.co.uk/shadowfacts/ + } +} + +dependencies { + compile group: "net.shadowfacts", name: "Forgelin", version: "LATEST_VERSION" +} +``` + +You _can_ shade Forgelin but it's not recommended, as it means users may be unintentionally downloading the entire Kotlin standard library, reflect library, and runtime multiple times.