From 0281ce1223d6825516ccd91f135487af416f63d3 Mon Sep 17 00:00:00 2001 From: Shane Freeder Date: Thu, 1 Feb 2018 16:57:15 +0000 Subject: [PATCH] [CI-SKIP] Update README --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 023086e..4781298 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Travertine +# Travertine Travertine is Waterfall with additional protocols. Waterfall is a fork of the well-known [BungeeCord](https://github.com/SpigotMC/BungeeCord) server teleportation suite. @@ -20,6 +20,18 @@ Travertine was forked because of the fact that Waterfall intends to only support Travertine will track upstream Waterfall and merge changes as needed. +## How to (Server Admins) + +Download a copy of of Travertine.jar from our buildserver here: [Travertine](https://ci.destroystokyo.com/job/Travertine) + +Travertine requires **java 8** or above. + +## How To (Compiling from source) + +To compile Travertine, you need JDK8, git, bash, maven, and an internet connection. + +Clone this repo, run `./build.sh` from *bash*, get jar from `Travertine-Proxy/bootstrap/target` + ## Join us * Feel free to open a PR! We accept contributions.