1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c4563a6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# pacwiz-serve
+
+a minimal docker (or podman) container to serve packwiz modpacks anywhere :)
+
+## how to use
+
+all you need is one command:
+
+```bash
+docker run -d --name packwiz-serve -p <your_desired_port>:8080 -v /path/to/your/modpack:/data getchoo/packwiz-serve
+```
+
+## troubleshooting
+
+### permission denied errors
+
+for users of a system with SELinux, you maybe need to append `:z` to your volume mount options.
+for example: `-v /path/to/your/modpack:/data:z`