From 191e58b9ee92a39e1a368d53feac6a4b3208cb37 Mon Sep 17 00:00:00 2001
From: xboard <xboard>
Date: Tue, 24 Mar 2026 00:01:13 +0800
Subject: [PATCH] docs: update readme.md

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

diff --git a/README.md b/README.md
index f33c4be..dbe1ba2 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,29 @@ docker run -d --restart=always --network=host \
   ghcr.io/cedar2025/xboard-node:latest
 ```
 
+### Docker Compose
+
+**1. Get the `compose/` directory**
+
+```bash
+git clone -b compose --depth 1 https://github.com/cedar2025/xboard-node.git
+cd xboard-node
+```
+
+
+**2. Edit local config**
+
+```bash
+vim config/config.yml
+# edit config/config.yml — set panel.url, panel.token, panel.node_id
+```
+
+**3. Start**
+
+```bash
+docker compose up -d
+```
+
 ## Features
 
 - **Kernels**: sing-box (default) / Xray-core.