docs: enhance readability and consistency in README and build script

Updated rule set names in README for better readability and consistency, ensuring all rule set titles are formatted uniformly. Adjusted the build script to reflect these changes, maintaining alignment between documentation and code.
liblaf · Aug 9, 2024 · a03f86b · a03f86b
1 parent ae1b1f2
commit a03f86b
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 68 deletions.
diff --git a/README.md b/README.md
@@ -1,24 +1,24 @@
 # sing-box Rules
 
-| Name                | Download Link                                                                                         |
-| ------------------- | ----------------------------------------------------------------------------------------------------- |
-| 📵 RuleSet:ADs      | [rule-set/ads.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/rule-set/ads.srs)           |
-| 🔒 RuleSet:Private  | [rule-set/private.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/rule-set/private.srs)   |
-| 🇨🇳 RuleSet:CN       | [rule-set/cn.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/rule-set/cn.srs)             |
-| 🤖 RuleSet:AI       | [rule-set/ai.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/rule-set/ai.srs)             |
-| 🍟 RuleSet:Emby     | [rule-set/emby.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/rule-set/emby.srs)         |
-| ☁️ RuleSet:Download | [rule-set/download.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/rule-set/download.srs) |
-| 📺 RuleSet:Media    | [rule-set/media.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/rule-set/media.srs)       |
-| 📵 GeoSite:ADs      | [geosite/ads.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/geosite/ads.srs)             |
-| 🔒 GeoSite:Private  | [geosite/private.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/geosite/private.srs)     |
-| 🇨🇳 GeoSite:CN       | [geosite/private.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/geosite/cn.srs)          |
-
-- `GeoSite:*` does not contain `IP-CIDR` rules, useful for DNS Rule.
-- [statistics](https://github.com/liblaf/sing-box-rules/blob/rule-sets/README.md).
+| Name                                       | Download Link                                                                                         |
+| ------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
+| [📵 RuleSet: ADs](#-ruleset-ads)           | [rule-set/ads.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/rule-set/ads.srs)           |
+| [🔒 RuleSet: Private](#-ruleset-private)   | [rule-set/private.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/rule-set/private.srs)   |
+| [🇨🇳 RuleSet: CN](#-ruleset-cn)             | [rule-set/cn.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/rule-set/cn.srs)             |
+| [🤖 RuleSet: AI](#-ruleset-ai)             | [rule-set/ai.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/rule-set/ai.srs)             |
+| [🍟 RuleSet: Emby](#-ruleset-emby)         | [rule-set/emby.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/rule-set/emby.srs)         |
+| [☁️ RuleSet: Download](#-ruleset-download) | [rule-set/download.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/rule-set/download.srs) |
+| [📺 RuleSet: Media](#-ruleset-media)       | [rule-set/media.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/rule-set/media.srs)       |
+| [📵 GeoSite: ADs](#-ruleset-ads)           | [geosite/ads.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/geosite/ads.srs)             |
+| [🔒 GeoSite: Private](#-ruleset-private)   | [geosite/private.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/geosite/private.srs)     |
+| [🇨🇳 GeoSite: CN](#-ruleset-cn)             | [geosite/private.srs](https://github.com/liblaf/sing-box-rules/raw/rule-sets/geosite/cn.srs)          |
+
+- `GeoSite: *` does not contain `IP-CIDR` rules, useful for DNS Rule.
+- [statistics](https://github.com/liblaf/sing-box-rules/blob/rule-sets/README.md)
 
 ## Optimization
 
-[optimization results](https://github.com/liblaf/sing-box-rules/blob/rule-sets/README.md).
+[optimization results](https://github.com/liblaf/sing-box-rules/blob/rule-sets/README.md)
 
 - remove duplicate rules
 - merge `DOMAIN` with `DOMAIN-SUFFIX`
@@ -27,80 +27,80 @@
 - merge `DOMAIN-SUFFIX` with `DOMAIN-KEYWORD`
 - merge `IP-CIDR`
 
-### 📵 RuleSet:ADs
+### 📵 RuleSet: ADs
 
 - include:
-  - [`blackmatrix7/Advertising.list`](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Advertising)
-  - [`DustinWin/geosite-all.db`](https://github.com/DustinWin/ruleset_geodata): `ads`
-  - [`MetaCubeX/geosite.db`](https://github.com/MetaCubeX/meta-rules-dat): `*-ads` | `*-ads-all` | `*@ads`
+  - [blackmatrix7/Advertising.list](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Advertising)
+  - [DustinWin/geosite-all.db](https://github.com/DustinWin/ruleset_geodata): `ads`
+  - [MetaCubeX/geosite.db](https://github.com/MetaCubeX/meta-rules-dat): `*-ads` | `*-ads-all` | `*@ads`
 
-### 🔒 RuleSet:Private
+### 🔒 RuleSet: Private
 
 - include:
-  - [`blackmatrix7/Lan.list`](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Lan)
-  - [`DustinWin/geoip-all.db`](https://github.com/DustinWin/ruleset_geodata): `private`
-  - [`DustinWin/geosite-all.db`](https://github.com/DustinWin/ruleset_geodata): `private`
-  - [`MetaCubeX/geoip.db`](https://github.com/MetaCubeX/meta-rules-dat): `private`
-  - [`MetaCubeX/geosite.db`](https://github.com/MetaCubeX/meta-rules-dat): `private`
+  - [blackmatrix7/Lan.list](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Lan)
+  - [DustinWin/geoip-all.db](https://github.com/DustinWin/ruleset_geodata): `private`
+  - [DustinWin/geosite-all.db](https://github.com/DustinWin/ruleset_geodata): `private`
+  - [MetaCubeX/geoip.db](https://github.com/MetaCubeX/meta-rules-dat): `private`
+  - [MetaCubeX/geosite.db](https://github.com/MetaCubeX/meta-rules-dat): `private`
 - exclude:
-  - [📵 RuleSet:ADs](#-rulesetads)
+  - [📵 RuleSet: ADs](#-ruleset-ads)
 
-### 🇨🇳 RuleSet:CN
+### 🇨🇳 RuleSet: CN
 
 - include:
-  - [`blackmatrix7/ChinaMax.list`](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/ChinaMax)
-  - [`blackmatrix7/Direct.list`](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Direct)
-  - [`blackmatrix7/NTPService.list`](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/NTPService)
-  - [`DustinWin/geoip-all.db`](https://github.com/DustinWin/ruleset_geodata): `cn`
-  - [`DustinWin/geosite-all.db`](https://github.com/DustinWin/ruleset_geodata): `cn`
-  - [`MetaCubeX/geoip.db`](https://github.com/MetaCubeX/meta-rules-dat): `cn`
-  - [`MetaCubeX/geosite.db`](https://github.com/MetaCubeX/meta-rules-dat): `*-cn` | `*-ntp*` | `*@cn` | `cn`
+  - [blackmatrix7/ChinaMax.list](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/ChinaMax)
+  - [blackmatrix7/Direct.list](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Direct)
+  - [blackmatrix7/NTPService.list](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/NTPService)
+  - [DustinWin/geoip-all.db](https://github.com/DustinWin/ruleset_geodata): `cn`
+  - [DustinWin/geosite-all.db](https://github.com/DustinWin/ruleset_geodata): `cn`
+  - [MetaCubeX/geoip.db](https://github.com/MetaCubeX/meta-rules-dat): `cn`
+  - [MetaCubeX/geosite.db](https://github.com/MetaCubeX/meta-rules-dat): `*-cn` | `*-ntp*` | `*@cn` | `cn`
 - exclude:
-  - [📵 RuleSet:ADs](#-rulesetads)
-  - [🔒 RuleSet:Private](#-rulesetprivate)
+  - [📵 RuleSet: ADs](#-ruleset-ads)
+  - [🔒 RuleSet: Private](#-ruleset-private)
 
-### 🤖 RuleSet:AI
+### 🤖 RuleSet: AI
 
 - include:
-  - [`blackmatrix7/Claude.list`](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Claude)
-  - [`blackmatrix7/Copilot.list`](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Copilot)
-  - [`blackmatrix7/Gemini.list`](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Gemini)
-  - [`blackmatrix7/OpenAI.list`](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/OpenAI)
-  - [`DustinWin/geosite-all.db`](https://github.com/DustinWin/ruleset_geodata): `ai`
-  - [`MetaCubeX/geosite.db`](https://github.com/MetaCubeX/meta-rules-dat): `openai`
+  - [blackmatrix7/Claude.list](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Claude)
+  - [blackmatrix7/Copilot.list](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Copilot)
+  - [blackmatrix7/Gemini.list](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Gemini)
+  - [blackmatrix7/OpenAI.list](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/OpenAI)
+  - [DustinWin/geosite-all.db](https://github.com/DustinWin/ruleset_geodata): `ai`
+  - [MetaCubeX/geosite.db](https://github.com/MetaCubeX/meta-rules-dat): `openai`
 - exclude:
-  - [📵 RuleSet:ADs](#-rulesetads)
+  - [📵 RuleSet: ADs](#-ruleset-ads)
 
-### 🍟 RuleSet:Emby
+### 🍟 RuleSet: Emby
 
 - include:
-  - [`NotSFC/Emby.json`](https://github.com/NotSFC/rulelist/blob/main/sing-box/Emby/Emby.json)
+  - [NotSFC/Emby.json](https://github.com/NotSFC/rulelist/blob/main/sing-box/Emby/Emby.json)
 
-### ☁️ RuleSet:Download
+### ☁️ RuleSet: Download
 
 🔴 latency insensitive, 🟢 high bandwidth
 
 - include:
-  - [`blackmatrix7/Developer.list`](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Developer)
-  - [`blackmatrix7/Download.list`](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Download)
-  - [`blackmatrix7/OneDrive.list`](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/OneDrive)
-  - [`liblaf/download.json`](https://github.com/liblaf/sing-box-rules/blob/main/custom/download.json)
-  - [`MetaCubeX/geosite.db`](https://github.com/MetaCubeX/meta-rules-dat): `category-dev` | `onedrive`
+  - [blackmatrix7/Developer.list](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Developer)
+  - [blackmatrix7/Download.list](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/Download)
+  - [blackmatrix7/OneDrive.list](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/OneDrive)
+  - [liblaf/download.json](https://github.com/liblaf/sing-box-rules/blob/main/custom/download.json)
+  - [MetaCubeX/geosite.db](https://github.com/MetaCubeX/meta-rules-dat): `category-dev` | `onedrive`
 - exclude:
-  - [📵 RuleSet:ADs](#-rulesetads)
-  - [🇨🇳 RuleSet:CN](#-rulesetcn)
+  - [📵 RuleSet: ADs](#-ruleset-ads)
+  - [🇨🇳 RuleSet: CN](#-ruleset-cn)
 
-### 📺 RuleSet:Media
+### 📺 RuleSet: Media
 
 🟢 low latency, 🟢 high bandwidth
 
 - include:
-  - [`blackmatrix7/GlobalMedia.list`](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/GlobalMedia)
-  - [`DustinWin/geosite-all.db`](https://github.com/DustinWin/ruleset_geodata): `youtube`
-  - [`MetaCubeX/geosite-lite.db`](https://github.com/MetaCubeX/meta-rules-dat): `proxymedia`, `youtube`
-  - [`MetaCubeX/geosite.db`](https://github.com/MetaCubeX/meta-rules-dat): `youtube`
+  - [blackmatrix7/GlobalMedia.list](https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/GlobalMedia)
+  - [DustinWin/geosite-all.db](https://github.com/DustinWin/ruleset_geodata): `youtube`
+  - [MetaCubeX/geosite-lite.db](https://github.com/MetaCubeX/meta-rules-dat): `proxymedia`, `youtube`
+  - [MetaCubeX/geosite.db](https://github.com/MetaCubeX/meta-rules-dat): `youtube`
 - exclude:
-  - [📵 RuleSet:ADs](#-rulesetads)
+  - [📵 RuleSet: ADs](#-ruleset-ads)
 
 ## Acknowledgement
 

diff --git a/scripts/build.py b/scripts/build.py
@@ -19,13 +19,13 @@ class Config:
 
 
 RULE_SETS: list[Config] = [
-    Config(id="ads", fn=preset.ads, name="📵 RuleSet:ADs", geosite=True),
-    Config(id="private", fn=preset.private, name="🔒 RuleSet:Private", geosite=True),
-    Config(id="cn", fn=preset.cn, name="🇨🇳 RuleSet:CN", geosite=True),
-    Config(id="ai", fn=preset.ai, name="🤖 RuleSet:AI"),
-    Config(id="emby", fn=preset.emby, name="🍟 RuleSet:Emby"),
-    Config(id="download", fn=preset.download, name="☁️ RuleSet:Download"),
-    Config(id="media", fn=preset.media, name="📺 RuleSet:Media"),
+    Config(id="ads", fn=preset.ads, name="📵 RuleSet: ADs", geosite=True),
+    Config(id="private", fn=preset.private, name="🔒 RuleSet: Private", geosite=True),
+    Config(id="cn", fn=preset.cn, name="🇨🇳 RuleSet: CN", geosite=True),
+    Config(id="ai", fn=preset.ai, name="🤖 RuleSet: AI"),
+    Config(id="emby", fn=preset.emby, name="🍟 RuleSet: Emby"),
+    Config(id="download", fn=preset.download, name="☁️ RuleSet: Download"),
+    Config(id="media", fn=preset.media, name="📺 RuleSet: Media"),
 ]