From 21c91fc21306d25a57eaa45b0f919ff6c7c36bda Mon Sep 17 00:00:00 2001
From: YANGJIANKUAN <tim.yee@hotmail.com>
Date: Tue, 31 Mar 2026 13:13:35 +0800
Subject: [PATCH] feat: add readme file

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9557c02
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Sub Router
+
+Surge 代理订阅管理系统。聚合多个上游订阅源，管理自定义节点和规则，生成合并后的 Surge 配置文件。
+
+## 快速开始
+
+```bash
+# 安装依赖
+npm install
+
+# 开发模式（前后端同时启动）
+npm run dev
+
+# 生产构建
+npm run build:web
+npm run start
+```
+
+## Docker 部署
+
+```bash
+docker compose up -d
+```
+
+服务运行在 `http://localhost:3456`，Surge 订阅地址为 `http://<host>:3456/surge`。
+
+## 技术栈
+
+- **后端**: Express + TypeScript + better-sqlite3
+- **前端**: React + Vite + TypeScript
+- **数据库**: SQLite