1 files changed, 24 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2760efc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Minecraft HTTP whitelist
+
+Simple python HTTP server for managing minecraft whitelist
+
+## Run server
+
+### Copy the edited systemd service file
+
+```sh
+sed s@{working_directory}@$PWD/@ minecraft-http-whitelist.service > ~/.config/systemd/user/minecraft-http-whitelist.service
+```
+
+### Edit config.py
+
+```sh
+vi config.py
+```
+
+### Run the server
+
+```sh
+systemctl --user daemon-reload 
+systemctl --user start minecraft-http-whitelist
+```