From f1eb5d83edaa319cab1ce049736299df6a5b4384 Mon Sep 17 00:00:00 2001
From: Erlend <49862976+Erb3@users.noreply.github.com>
Date: Wed, 10 Apr 2024 13:49:42 +0200
Subject: [PATCH] docs: docker instructions

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index c083152..9c40a18 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,28 @@
 
 A geography game inspired by [Posio](https://github.com/abrenaut/posio), written in 🔥🚀Rust.
 
+## Deployment
+
+Sveio is available as a docker image. If you use `docker run` you can run the following to start it:
+
+```bash
+docker run -d -p 8085:8085 --env-file=.env ghcr.io/erb3/sveio:main
+```
+
+Alternatively, you can use the following docker compose:
+
+```yml
+services:
+  sveio:
+    container_name: sveio
+    image: ghcr.io/erb3/sveio:main
+    ports:
+      - 8085:8085
+    restart: unless-stopped
+    env_file:
+      - .env
+```
+
 ## Configuration
 
 The server uses the following environmental variables, and it also parses the .env file if present: