From b35653f8f746ee1c3e5435f1131221c748e12a33 Mon Sep 17 00:00:00 2001
From: 1e99 <noemail@noemail>
Date: Sun, 29 Jun 2025 12:49:09 +0200
Subject: [PATCH] improve readme

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

diff --git a/README.md b/README.md
index d1206fa..d899c63 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,50 @@
 # 2b2t
 A 2b2t queue tracker.
+
+## Setup
+The queue tracker can be setup using docker compose.
+
+1. Add this to your docker compose:
+```yaml
+services:
+  # The master
+  "2b2t":
+    build:
+      context: "https://git.1e99.eu/1e99/2b2t.git"
+      dockerfile: "Dockerfile"
+    ports:
+      - "3000:3000"
+    volumes:
+      - "./data.sqlite:/data.sqlite"
+    environment:
+      "MASTER_DATABASE": "/data.sqlite"
+      "MASTER_ADDRESS": ":3000"
+    networks:
+      - "2b2t"
+
+  # The worker which pings 2b2t
+  "2b2t_worker":
+    build:
+      context: "https://git.1e99.eu/1e99/2b2t.git"
+      dockerfile: "Dockerfile.worker"
+    environment:
+      "WORKER_SUBMIT_URL": "http://2b2t:3000/api/player-count"
+      "WORKER_TOKEN": "secret_token"
+    networks:
+      - "2b2t"
+
+networks:
+  "2b2t": {}
+```
+
+2. Start the containers:
+```sh
+docker compose up -d
+```
+
+3. Insert the worker tokens into your master's database.
+```sh
+sqlite3 data.sqlite
+sqlite> INSERT INTO worker (name, token) VALUES ("name", "secret_token");
+sqlite> .exit
+```