Merge branch 'master' of https://github.com/franga2000/BungeeStatus

README.md

@@ -1,4 +1,48 @@
 BungeeStatus
 ============
 
-A PHP powered website to show players the status of your BungeeCord network
+BungeeStatus is a PHP powered website that allows server owners with PHP-capable web server to show their players which of their servers are online, how many players are there on each and if they are down, why.
+
+
+##Installation:
+
+* Upload to your webserver
+* Change the settings in config.php
+* Add your servers to servers.json
+* Check your servers.json file using a json parser (http://www.jsoneditoronline.org)
+
+###CONFIGURATION:
+config.php:
+```php
+$password = 'CHANGE-THIS'; //Not implemented yet
+$columns = 2; //The number of columns on the page
+```
+servers.json:
+```json
+{
+  "servers": [
+    {
+      "Name": "Server display name",
+      "Adress": "Server adress",
+      "Port": "Server QUERY port",
+      "Description": "Description (optional)",
+      "Offline_reason": "Reason shown when the server is offline (optional)"
+    },
+    {
+      "Name": "Hub",
+      "Adress": "127.0.0.1",
+      "Port": 25570,
+      "Description": "The server used for passing between servers"
+    }
+  ]
+}
+```
+**Everything except the port MUST HAVE QUOTES!**
+
+**Each item inside brackets ([] or {}) except the last one has to be folowed by a comma (,)!**
+
+##Credits:
+
+* Most of everything: franga2000 (http://franga2000.com)
+* Minecraft Query Script: xPaw (https://github.com/xPaw/PHP-Minecraft-Query)
+* Json Fancify Script: Dave Perrett (http://www.daveperrett.com/articles/2008/03/11/format-json-with-php/)