diff --git a/README.md b/README.md index 3a4efd6ce..872a678fa 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,14 @@ python3 src/rulegen.py --config configs/config.json --names Apple,YouTube - `dist/clash/.yaml` - `dist/mihomo/.yaml` +## 快捷方式 + +- 规则说明:`dist/README.md` +- Surge 目录:`dist/surge/` +- Loon 目录:`dist/loon/` +- Clash 目录:`dist/clash/` +- Mihomo 目录:`dist/mihomo/` + ## 配置说明 默认配置:`configs/config.json` diff --git a/dist/README.md b/dist/README.md new file mode 100644 index 000000000..2cf1ef4cf --- /dev/null +++ b/dist/README.md @@ -0,0 +1,34 @@ +# 规则说明 + +本目录提供可直接引用的分流规则文件。 + +## 目录 + +- `surge/`:Surge 规则(`.list`) +- `loon/`:Loon 规则(`.list`) +- `clash/`:Clash Provider(`.yaml`) +- `mihomo/`:Mihomo Provider(`.yaml`) + +## 快速使用 + +仓库 Raw 基础地址: + +- `https://git.halonice.com/yuanzhen869/shunt-rules/raw/branch/main/dist` + +示例: + +- Surge `Apple`:`https://git.halonice.com/yuanzhen869/shunt-rules/raw/branch/main/dist/surge/Apple.list` +- Loon `Apple`:`https://git.halonice.com/yuanzhen869/shunt-rules/raw/branch/main/dist/loon/Apple.list` +- Clash `Apple`:`https://git.halonice.com/yuanzhen869/shunt-rules/raw/branch/main/dist/clash/Apple.yaml` +- Mihomo `Apple`:`https://git.halonice.com/yuanzhen869/shunt-rules/raw/branch/main/dist/mihomo/Apple.yaml` + +## 命名规则 + +- 文件名为分类名,如 `Apple`、`YouTube`、`OpenAI`。 +- Surge/Loon 后缀为 `.list`。 +- Clash/Mihomo 后缀为 `.yaml`。 + +## 更新方式 + +- 由仓库工作流自动同步上游并生成。 +- 以 `main` 分支最新内容为准。