From de655ee432adf15da40fa135ffb3d578544c632c Mon Sep 17 00:00:00 2001
From: Lilly Tempest <46890129+rainbowdashlabs@users.noreply.github.com>
Date: Wed, 24 May 2023 15:24:39 +0200
Subject: [PATCH] Add documentation for routes config file (#194)

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

diff --git a/README.md b/README.md
index acc1f61..f7850d7 100644
--- a/README.md
+++ b/README.md
@@ -109,6 +109,22 @@ To test out this example, I added these two entries to my "hosts" file:
 127.0.0.1 forge.example.com
 ```
 
+# Routing Configuration
+
+The routing configuration allows routing via a config file rather than a command. 
+You need to set `-routes-config` or `ROUTES_CONFIG` env variable.
+The following shows a JSON file for routes config, where `default-server` can also be `null` or omitted:
+
+```json
+{
+  "default-server": "vanilla:25565",
+  "mappings": {
+    "vanilla.example.com": "vanilla:25565",
+    "forge.example.com": "forge:25565"
+  }
+}
+```
+
 # Kubernetes Usage
 
 ## Using Kubernetes Service auto-discovery