From 07fcf89a60dfa53a46f62c97b81a124a13b57cac Mon Sep 17 00:00:00 2001
From: Marc Cataford <mcat@riseup.net>
Date: Tue, 5 Nov 2024 22:23:43 -0500
Subject: [PATCH] docs: update README

---
 README.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 1c51bb8..5fc3b9a 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,18 @@
 
 Forgejo instance serving https://forge.karnov.club.
 
-## Maintaining
+## Usage
+
+### Starting the Forgejo instance
 
 Using [spud](https://forge.karnov.club/spadinastan/spud), just `spud start ./service.yml`!
 
 ### Starting runners
 
+Runner metadata (i.e. version, per-instance configuration) is defined under `metadata.json`.
+
+Before starting the runners, they should be registered via `RUNNER_HOME=... ./runners.py register`. An interactive prompt needs to be filled for each runner to enter details and tokens.
+
 ```
-./runners.py start
+RUNNER_HOME=<path> ./runners.py start
 ```