From bbf2e8e981ad094d1fd7fc95a985d89af9558d64 Mon Sep 17 00:00:00 2001
From: Marcel Hanraets <marcel@hanraets.eu>
Date: Fri, 18 Jul 2014 18:01:36 +0200
Subject: [PATCH] Added README

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..da21686
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Craftmin
+
+A collection of script to configure and manage a CraftBukkit Minecraft server.
+
+### Files
+
+| Filename         | Description                  |
+| ---------------- | ---------------------------- |
+| `craftbukkit.sh` | Init script                  |
+| `bukkit-log.xml` | Server log configuration     |
+| `craftmin.sh`    | CraftBukkit management script|
+
+### Features
+
+TBC
+
+### Requirements
+
+- tmux
+- sysvinit (systemd is currently not supported)
+
+### Setup
+
+1. Edit the configuration to your linking
+2. Install the init script:
+
+        mv craftbukkit.sh /etc/init.d/craftbukkit
+        chmod 755 /etc/init.d/craftbukkit
+        update-rc.d craftbukkit defaults