From ca61d6aef7906c150ba53282b6f2e2f731bd2d0a Mon Sep 17 00:00:00 2001 From: CDFN Date: Fri, 7 Aug 2020 21:13:48 +0200 Subject: [PATCH 1/4] Add plugin developers section --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index dfd22b339..df5396723 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](https://papermc.io/javadocs/) + * Maven Repo (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. From 7300358b4f6c5d729771f34cb186bd9f3c90b38a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bartosz=20Stefa=C5=84czyk?= Date: Wed, 26 Aug 2020 16:54:49 +0200 Subject: [PATCH 2/4] Add plugin developers section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index df5396723..2252ef770 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Waterfall requires **Java 8** or above. ## How To (Plugin Developers) ------ * See our API patches [here](BungeeCord-Patches) - * Waterfall API javadocs here: [papermc.io/javadocs](https://papermc.io/javadocs/) + * Waterfall API javadocs here: [papermc.io/javadocs/waterfall](https://papermc.io/javadocs/waterfall) * Maven Repo (for waterfall-api): ```xml From de499d3eecc5803d46b9e53ebd8eb0b67535c87d Mon Sep 17 00:00:00 2001 From: Shane Freeder Date: Thu, 17 Sep 2020 17:19:39 +0100 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Mariell --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2252ef770..fbce96eaf 100644 --- a/README.md +++ b/README.md @@ -28,14 +28,14 @@ Waterfall requires **Java 8** or above. ------ * See our API patches [here](BungeeCord-Patches) * Waterfall API javadocs here: [papermc.io/javadocs/waterfall](https://papermc.io/javadocs/waterfall) - * Maven Repo (for waterfall-api): + * Maven repository (for `waterfall-api`): ```xml papermc https://papermc.io/repo/repository/maven-public/ ``` - * Artifact Information: + * Artifact information: ```xml io.github.waterfallmc From a4ab849bc844665eb5c252d0bc6b39273d576301 Mon Sep 17 00:00:00 2001 From: Shane Freeder Date: Thu, 17 Sep 2020 17:20:34 +0100 Subject: [PATCH 4/4] tempcommitgoingtoremove --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fbce96eaf..642739261 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ 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) + * Waterfall API JavaDocs here: [papermc.io/javadocs/waterfall](https://papermc.io/javadocs/waterfall) * Maven repository (for `waterfall-api`): ```xml