1 files changed, 22 insertions, 0 deletions
diff --git a/minecraft/README.md b/minecraft/README.md
new file mode 100644
index 0000000..daedb32
--- /dev/null
+++ b/minecraft/README.md
@@ -0,0 +1,22 @@
+### images/minecraft
+
+runs a miencraft server, very cool
+
+#### volumes
+
+- /data stores the minecraft server files
+
+#### environment
+
+- MC_TYPE can be `vanilla`,`paper`,`waterfall`,`velocity`,`folia`,`fabric`, or `forge`
+- MC_VERSION is the minecraft version [`latest`,`snapshot`,`<version>`]
+
+extra environment variables include
+- PAPERMC_BUILD
+- FABRIC_LOADER
+- FABRIC_INSTALLER
+- FORGE_VERSION [`recommended`, `latest`, `<version>`]
+
+jvm configuration
+- JVMARGS - overwrites the default jvm args
+- MEMORY - sets the jvm memory amount (default 1G)