diff --git a/README.md b/README.md index dfd22b3..6427392 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,44 @@ Download a copy of Waterfall.jar from our buildserver here: [Waterfall](https:// Waterfall requires **Java 8** or above. +## How To (Plugin Developers) +------ + * See our API patches [here](BungeeCord-Patches) + * Waterfall API JavaDocs here: [papermc.io/javadocs/waterfall](https://papermc.io/javadocs/waterfall) + * Maven repository (for `waterfall-api`): +```xml + + papermc + https://papermc.io/repo/repository/maven-public/ + +``` + * Artifact information: +```xml + + io.github.waterfallmc + waterfall-api + 1.16-R0.4-SNAPSHOT + provided + + ``` + +**Or alternatively, with Gradle:** + + * Repository: +```groovy +repositories { + maven { + url 'https://papermc.io/repo/repository/maven-public/' + } +} +``` + * Artifact: +```groovy +dependencies { + compileOnly 'io.github.waterfallmc:waterfall-api:1.16-R0.4-SNAPSHOT' +} +``` + ## How To (Compiling From Source) To compile Waterfall, you need JDK8, git, bash, maven, and an internet connection.