From eeda87c7dc234d6669735e3b4f7138778bf9bea8 Mon Sep 17 00:00:00 2001 From: Tux Date: Sun, 29 Sep 2013 16:22:52 -0400 Subject: [PATCH] README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4e0cad1 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# RedisBungee + +RedisBungee bridges [Redis](http://redis.org) and BungeeCord together. This is the solution deployed on [The Chunk](http://thechunk.net) to make sure our multi-Bungee setup flows smoothly together. + +## Compiling + +RedisBungee is distributed as a [maven](http://maven.apache.org) project. To compile it: + + git clone https://github.com/minecrafter/RedisBungee.git + cd RedisBungee + mvn clean package + +## Configuration + +**REDISBUNGEE REQUIRES A REDIS SERVER**, preferably with reasonably low latency. The default [config](https://github.com/minecrafter/RedisBungee/blob/master/src/main/resources/example_config.yml) is saved when the plugin first starts.