From 991a0ced6702ef95e3e86406554e2e7f267b62fa Mon Sep 17 00:00:00 2001 From: Andreas Troelsen Date: Sun, 12 Mar 2017 12:17:01 +0100 Subject: [PATCH] Rewrite README. --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f2765b7..86e99cb 100644 --- a/README.md +++ b/README.md @@ -1 +1,28 @@ -Please read the [Wiki](https://github.com/garbagemule/MobArena/wiki/Installing-MobArena) for details on how to set up MobArena, and remember to read the [FAQ](https://github.com/garbagemule/MobArena/wiki/FAQ) before posting questions! +# MobArena +MobArena is an arena-style minigame for Bukkit-based Minecraft servers. + +## Getting Started +If you don't want to compile the plugin yourself, grab a release artifact from +one of these two sites: + +- [Bukkit](https://dev.bukkit.org/projects/mobarena) +- [Spigot](https://www.spigotmc.org/resources/34110/) + +The wiki here on Github should have all the information you need to get +started using the plugin. + +## Getting Help +If you run into problems or need help with something, feel free to hop on IRC +(#mobarena @ irc.esper.net) to have a chat. If you don't know what IRC is or +don't have an IRC client, you can use a web-based one: + +- [Webchat](https://webchat.esper.net/?nick=&channels=#mobarena) + +Remember, though, that IRC is _idle chat_, which means you likely won't get a +response immediately. It could take anything from a couple of seconds to a +day, but your message _will_ be seen. + +## Bugs and Suggestions +Found a bug or have a great idea for the plugin? Use the issue tracker here on +Github to submit a bug report or feature request. Please have a look through +the existing issues before you post a new one to avoid duplicates.