From 57de6210221b51a7f0a040be74ac977271c2e3b6 Mon Sep 17 00:00:00 2001 From: Twilight <121682528+TG-Twilight@users.noreply.github.com> Date: Fri, 8 Nov 2024 10:39:31 +0800 Subject: [PATCH] update build README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 0f760fc..06c6100 100755 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ +## 如何贡献规则? + +fork本分支,修改本目录的文件(前提是你有一定量的适合本规则的广告域名,我们并不乐意处理仅提交一个域名的Pr)。 + +否则我们**强烈建议**你在 issue 直接提出:xxxxxxx是xxxxx的广告域名/是被错误拦截的,建议拦截/放行,并且附上必要的图片之类。 + + ## build 此分支将构建[rule](./rule)中的基础规则 @@ -10,3 +17,13 @@ ```shell python main.py ``` + +## 须知 + +`domain.txt` 文件为域名列表 一行一个 不会匹配子域名 + +`domain_regex.txt` 文件为`domain.txt`的正则表达式版本(并不是所有插件都会调用此规则) + +`ip.txt` 文件为ipv4列表(并不是所有插件都会调用此规则) + +`ip6.txt` 文件为ipv6列表(并不是所有插件都会调用此规则)