From 544604438c634ab5100ba4f0900a21e3ad9ce7ec Mon Sep 17 00:00:00 2001
From: jqtmviyu <jqtmviyu@gmail.com>
Date: Wed, 31 Jul 2024 03:43:08 +0800
Subject: [PATCH] docs: :memo: update readme

---
 README.md | 36 +++++++++++++++++++++++++++++-------
 1 file changed, 29 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 1953e6e..64fbda5 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
-# openwrt屏蔽吸血客户端和 pcdn ip段
+# transmisson屏蔽吸血客户端和 pcdn ip段
 
 > 为transmisson屏蔽迅雷等吸血客户端
 
 [教程地址](https://github.com/jqtmviyu/BTN-Collected-Rules)
 
 
-## 防火墙阻止吸血客户端
+## 防火墙阻止吸血
 
 1. 创建脚本
 
@@ -13,17 +13,39 @@
 
 因为是在openwrt中运行,所以有点不太一样
 
-下载 `block_xunlei.sh` 并修改
+###  白名单模式: 
 
-ps: 如果要在linux中运行, 可能需要将 `cut -d " " -f 1 ` 改回 `cut --delimiter " " --fields 1`
+`allow_whitelist.sh`
 
-2. 添加计划任务
+* 除了`whitelist_pattern="Transmission|qBittorrent|µTorrent|aria2|BitComet"`, 其余都会被屏蔽
+* 例外情况: `special_pattern="qbittorrent/3\.3\.15|Transmission\ 2\.9|BitComet\ 2\.04"`, 这些也会被屏蔽
+* 当时间的小时数字是4的整数倍时,清空防火墙规则和log (eg:0/4/8...)
+* 加入没什么用的彩色输出
+* `--debug`: 调试模式会打印更多信息,但不会写入log和添加防火墙
+* `--chain`: 查看防火墙已添加的ip
+* `--log`: 查看日志
+* `--flush`: 清空防火墙规则和log
+* `--help`: 帮助信息
+
+### 黑名单模式
+
+`block_blacklist.sh`
+
+* block_clients: 里的都会被阻止,每行一条
+* 当时间的小时数字是4的整数倍时,清空防火墙规则和log (eg:0/4/8...)
+* `--debug`: 调试模式会打印更多信息,但不会写入log和添加防火墙
+* `--chain`: 查看防火墙已添加的ip
+* `--log`: 查看日志
+* `--flush`: 清空防火墙规则和log
+* `--help`: 帮助信息
+
+### 添加计划任务
 
 每两分钟运行一次
 
 ```crontab
 PATH=/usr/sbin:/usr/bin:/sbin:/bin
-*/2 * * * * /root/block_xunlei.sh 2>> /root/block_xunlei.log
+*/2 * * * * /root/allow_whitelist.sh 2>> /tmp/allow_whitelist.log
 ```
 
 ## 添加屏蔽url
@@ -41,5 +63,5 @@ github action 每天自动更新
 下载并修改`update_transmission_blacklist.sh`
 
 ```crontab
-0 5 * * * /root/update_transmission_blacklist.sh 2>> /root/block_xunlei.log
+0 5 * * * /root/update_transmission_blacklist.sh 2>> /tmp/allow_whitelist.log
 ```
\ No newline at end of file