Add README.md

README.md

@@ -0,0 +1,12 @@
+# mcserver
+dead simple wrapper script to manage multiple minecraft server instances in
+tmux, in a way that makes it extremely easy to use with systemd.
+
+## instructions
+1. install systemd unit in /etc/systemd/system, change `User` option to preferred user
+2. create minecraft server instances in `~/.local/share/mcserver/instances`
+	- you can also symlink server directories from elsewhere on the system
+	- use `instance/` as a starting point. you need, at minimum, a startup
+	  script that executes the server jar, the server jar itself and a `vars`
+	  file
+3. `systemctl enable --now mcserver@instancename`