From 6219fc58fd145a75a68f6fc2642814c43402ab7e Mon Sep 17 00:00:00 2001 From: gently Date: Fri, 20 Dec 2019 10:08:43 +0800 Subject: [PATCH] update readme --- README.md | 42 +++++++++++++++++++++++++----------------- 1 file changed, 25 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b963aa1c..cf1ec6d4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,25 @@ -# anti-AD v4.0 +# anti-AD v4 -### 基于dnsmasq服务的广告封杀、恶意网站屏蔽、隐私保护工具 +##### anti-AD是综合著名广告过滤列表的高效广告屏蔽、隐私保护工具。能主动探测域名，支持国内外广告分开屏蔽，现已支持AdGuardHome，dnsmasq， Surge，Pi-Hole等 + +## 快速使用 + +### 1. dnsmasq +1. 下载[adblock-for-dnsmasq.conf](https://raw.githubusercontent.com/privacy-protection-tools/anti-AD/master/adblock-for-dnsmasq.conf) ([国内加速](https://anti-ad.oss-cn-shanghai.aliyuncs.com/adblock-for-dnsmasq.conf)), 保存到你的dnsmasq配置的正确目录下； +2. 重启dnsmasq服务； +3. 已经生效了，enjoy it！ + +### 2. AdGuardHome +1. 进入AdGuardHome过滤器页面，选择添加过滤器 +2. 输入名称 `anti-AD`，url地址：`https://anti-ad.oss-cn-shanghai.aliyuncs.com/anti-ad-easylist.txt` +3. 点击确认后即生效 + +### 3. Pi-Hole +1. 进入Pi-Hole的配置界面 +2. 添加 `https://anti-ad.oss-cn-shanghai.aliyuncs.com/anti-ad-easylist.txt` 作为新的过滤器 +3. 保存后生效 + +## Changelog #### v4.0 (2019.12.14) @@ -9,26 +28,15 @@ - 代码重构，工程化，分离class，分离工具，逻辑更清晰 -## 快速使用 - -1. 下载[adblock-for-dnsmasq.conf](https://raw.githubusercontent.com/privacy-protection-tools/anti-AD/master/adblock-for-dnsmasq.conf) ([国内加速](https://anti-ad.oss-cn-shanghai.aliyuncs.com/adblock-for-dnsmasq.conf)), 保存到你的dnsmasq配置的正确目录下； -2. 重启dnsmasq服务； -3. 已经生效了，enjoy it！ - ## 个性化 运行start.sh,会去下载easylist,yhosts,neohosts,cjxlist等其他大神维护的屏蔽列表，然后整理合并成一个文件。拿着这个文件放入到例如/etc/dnsmasq.d/的目录下，然后重启dnsmasq进程就能加载。更新依赖于其他大神的内容更新了。 -* `adblock-for-dnsmasq.conf` - 这个是最终生成的配置文件，大约每月更新4次,所以，如果你打算直接下载我维护的这个文件，不需要太高的pull频率 - -* `make-addr.php` - 是php脚本的主文件,执行php make-addr.php将更新配置文件 - -* `black_domain_list.php` - 是用来配置域名黑名单，这个威力巨大，谨慎使用 - -* `white_domain_list.php` - 白名单，优先级低于黑名单，即一个域名同时出现在黑白名单中时，将采用黑名单规则 - -* `block_domains.root.conf` - 这个文件是用来配置无论别人怎么更新，你都要保留的配置的，满足个性化需求，随心所欲。 +* `adblock-for-dnsmasq.conf` - 这个是最终生成的支持dnsmasq的广告屏蔽列表 +* `anti-ad-easylist.txt` - 这个是最终生成的easylist格式，同时支持Pi-Hole，AdGuardHome的广告屏蔽列表 +* `anti-ad-surge.txt` - 这个是最终生成的支持Surge格式的广告屏蔽列表 +* `make-addr.php` - 是php脚本的主文件,执行php make-addr.php将更新屏蔽列表 ## 欢迎提意见