From 1ba51886f4b5fa7779164c3fad43f9d19fee7969 Mon Sep 17 00:00:00 2001
From: Minecon724 <git@m724.eu>
Date: Mon, 17 Feb 2025 09:10:30 +0100
Subject: [PATCH] docs: Add readme

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6c7252d..d7e36ae 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,41 @@
 - `/api/server/heartbeat` - server heartbeat
 - `/api/plugin/{id}` - plugin info
-- `/api/plugin/find/{name}` - find a plugin id by name
\ No newline at end of file
+- `/api/plugin/find/{name}` - find a plugin id by name
+
+## Deployment
+**Note:** if you have any issues with the build, do `./mvnw clean` and try again.
+
+### Docker
+The best way to deploy is using Docker.
+
+To build an image:
+```bash
+./mvnw install -Dquarkus.container-image.build=true
+```
+
+TODO write instructions.
+
+### Java
+#### Normal JAR
+To build a JAR:
+```bash
+./mvnw package
+```
+The output will be `target/quarkus-app/quarkus-run.jar` \
+You to distribute the whole `target/quarkus-app` directory.
+
+#### Uber JAR
+To build an uber-JAR:
+```bash
+./mvnw package -Dquarkus.package.jar.type=uber-jar
+```
+The output will be `target/mstats-1.0.0-runner.jar` \
+You only need distribute that JAR.
+
+### Native
+To build a GraalVM native image:
+```bash
+./mvnw package -Dnative
+```
+The output will be `target/mstats-1.0.0-runner` \
+You only need to distribute that executable.