Merge pull request #722 from PBH-BTN/docs

English ReadME
PBH-BTN · Nov 11, 2024 · 5a4f742 · 5a4f742
2 parents 4bf10fd + b46fb0c
commit 5a4f742
Show file tree

Hide file tree

Showing 2 changed files with 141 additions and 55 deletions.
diff --git a/README.CN.md b/README.CN.md
@@ -0,0 +1,94 @@
+# PeerBanHelper
+[English](./README.md)
+
+自动封禁不受欢迎、吸血和异常的 BT 客户端，并支持自定义规则。
+
+![page-views](https://raw.githubusercontent.com/PBH-BTN/views-counter/refs/heads/master/svg/754169590/badge.svg)
+## 功能介绍
+
+PeerBanHelper 主要由以下几个功能模块组成：
+
+- [PeerID 黑名单](https://docs.pbh-btn.com/docs/module/peer-id)
+- [Client Name 黑名单](https://docs.pbh-btn.com/docs/module/client-name)
+- [IP/GeoIP/IP 类型 黑名单](https://docs.pbh-btn.com/docs/module/ip-address-blocker)
+- [虚假进度检查器（提供启发式客户端检测功能）](https://docs.pbh-btn.com/docs/module/progress-cheat-blocker)
+- [自动连锁封禁](https://docs.pbh-btn.com/docs/module/auto-range-ban)
+- [多拨追猎](https://docs.pbh-btn.com/docs/module/multi-dial)
+- Peer ID/Client Name 伪装检查；通过 [AviatorScript 引擎](https://docs.pbh-btn.com/docs/module/expression-engine) 实现
+- [主动监测（提供本地数据分析功能）](https://docs.pbh-btn.com/docs/module/active-monitoring)
+- [网络 IP 集规则订阅](https://docs.pbh-btn.com/docs/module/ip-address-blocker-rules)
+- WebUI （目前支持：活跃封禁名单查看，历史封禁查询，封禁最频繁的 Top 50 IP，规则订阅管理，图表查看，Peer 列表查看）
+
+此外，PeerBanHelper 会在启动时下载 GeoIP 库，成功加载后支持以下功能：
+
+- 在封禁列表中查看 IP 归属地，AS 信息（ASN、ISP、AS 名称等），网络类型信息（宽带、基站、物联网、数据中心等）
+- 基于 GeoIP 信息按国家/地区、城市、网络类型、ASN 等封禁 IP 地址
+- 查看 GeoIP 统计数据
+
+> [!TIP]
+> 为获得最佳效果，建议配合我们维护的 IP 规则库 [PBH-BTN/BTN-Collected-Rules](https://github.com/PBH-BTN/BTN-Collected-Rules) 和 [BTN 网络](https://docs.pbh-btn.com/docs/btn/intro) 一起食用，不过这是完全可选的。
+
+
+## 支持的客户端
+
+- qBittorrent **4.5.0 或更高版本**
+- BiglyBT（需要安装[插件](https://github.com/PBH-BTN/PBH-Adapter-BiglyBT)）
+- Deluge（需要安装[插件](https://github.com/PBH-BTN/PBH-Adapter-Deluge)）
+- Azureus(Vuze)（需要安装[插件](https://github.com/PBH-BTN/PBH-Adapter-Azureus)）
+- Transmission **(不建议使用；3.00-20 或更高版本)**
+- BitComet **v2.10 Beta6 [20240928] 或更高版本**
+
+
+# 截图
+
+| 主界面                                                                                                                                | 封禁列表                                                                                                                             | 封禁日志                                                                                                                             | 封禁统计                                                                                                                            | 规则统计                                                                                                                                | 规则订阅                                                                                                                                |
+| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
+| <img width="1280" alt="homepage" src="https://github.com/PBH-BTN/PeerBanHelper/assets/19235246/d7f7ea9f-70df-40f1-a782-260450972bc9"> | <img width="1280" alt="banlist" src="https://github.com/PBH-BTN/PeerBanHelper/assets/19235246/c3e139e6-eb82-423f-b083-1839713ec801"> | <img width="1280" alt="banlogs" src="https://github.com/PBH-BTN/PeerBanHelper/assets/19235246/00d8efcc-0dd7-4e05-bdeb-9444e14739d6"> | <img width="1280" alt="maxban" src="https://github.com/PBH-BTN/PeerBanHelper/assets/30802565/ae78ebb9-67f7-481a-9afc-7ced2c6a2534"> | <img width="1280" alt="banMetrics" src="https://github.com/PBH-BTN/PeerBanHelper/assets/19235246/9e4cd7b7-aaff-4b66-8d1d-ad4ef3466b1f"> | <img width="1280" alt="banMetrics" src="https://github.com/PBH-BTN/PeerBanHelper/assets/19235246/dc312186-9643-4f23-9d53-7b8e0852f228"> |
+
+## 安装 PeerBanHelper
+
+查看 [PeerBanHelper 文档](https://docs.pbh-btn.com/docs/category/%E5%AE%89%E8%A3%85%E9%83%A8%E7%BD%B2)
+
+
+## 常见问题
+
+在报告问题前，请先检查 [常见问题列表](https://docs.pbh-btn.com/docs/faq)
+
+## 声明
+
+违法网站和黑灰产请勿向我组织开发或支持人员发起任何形式的人工服务请求；严禁使用 PBH-BTN 团队的任何服务、产品从事任何违法违规、危害国家安全、实施或帮助他人实施电信犯罪等非法活动。  
+用户不得通过 PBH-BTN 团队的任何服务、产品进行任何损害其它个人或组织的利益的活动。在任何违反个人或组织权益的情况下使用 PBH-BTN 团队的任何服务、产品均不被允许。
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=PBH-BTN/PeerBanHelper&type=Date)](https://star-history.com/#PBH-BTN/PeerBanHelper&Date)
+
+## Credit
+
+### Backend
+
+- [Cordelia](https://github.com/bochkov/cordelia)
+- [IPAddress](https://github.com/seancfoley/IPAddress)
+- [YamlConfiguration](https://github.com/bspfsystems/YamlConfiguration)
+- [libby](https://github.com/AlessioDP/libby)
+- [AviatorScript](https://github.com/killme2008/aviatorscript)
+- [javalin](https://javalin.io/)
+- [deluge-java](https://github.com/RangerRick/deluge-java)
+- [jSystemThemeDetector](https://github.com/Dansoftowner/jSystemThemeDetector)
+- [Methanol](https://github.com/mizosoft/methanol)
+- [Flatlaf](https://github.com/JFormDesigner/FlatLaf)
+- [GeoIP2](https://dev.maxmind.com/geoip)
+- [ormlite](https://ormlite.com/)
+- [SimpleReloadLib](https://github.com/Ghost-chu/SimpleReloadLib)
+
+### WebUI
+
+- [Vue](https://vuejs.org/)
+- [ArcoDesign](https://arco.design/)
+- [ECharts](https://echarts.apache.org/en/index.html)
+
+### Install4j
+
+PeerBanHelper 使用 [Install4j multi-platform installer builder](https://www.ej-technologies.com/products/install4j/overview.html) 打包多平台安装程序。感谢 ej-technolgies 的开放源代码许可证。点击链接或者下面的图片下载 install4j。
+
+[![Install4j](https://www.ej-technologies.com/images/product_banners/install4j_large.png)](https://www.ej-technologies.com/products/install4j/overview.html)
diff --git a/README.md b/README.md
@@ -1,76 +1,62 @@
 # PeerBanHelper
+[简体中文](./README.CN.md)
 
-自动封禁不受欢迎、吸血和异常的 BT 客户端，并支持自定义规则。
+Automatically block unwanted, leeches and abnormal BT peers with support for customized and cloud rules.
 
 ![page-views](https://raw.githubusercontent.com/PBH-BTN/views-counter/refs/heads/master/svg/754169590/badge.svg)
-
-> [!NOTE]
-> PeerBanHelper 没有内建的更新检查程序，记得时常回来看看是否有新的版本更新，或者 Watch 本仓库(Custom -> Releases, Issues 和 Discussions)以接收版本更新通知  
-> QQ 交流群：932978658，如果在使用过程中需要帮助，您可以在这里和他人一同交流。或者在 [Issue Tracker](https://github.com/Ghost-chu/PeerBanHelper/issues) 打开新问题
-
-> [!TIP]
-> 您只需要正确连接 PBH 到下载器就可以正常工作，大多数情况下，并不需要额外配置
+## Introduction
+
+Following function are provided byPeerBanHelper:
+
+- [PeerID Blacklist](https://docs.pbh-btn.com/docs/module/peer-id)
+- [Client Name Blacklist](https://docs.pbh-btn.com/docs/module/client-name)
+- [IP/GeoIP/IP type Blacklist](https://docs.pbh-btn.com/docs/module/ip-address-blocker)
+- [Fake progress checker (heuristic client detection)](https://docs.pbh-btn.com/docs/module/progress-cheat-blocker)
+- [Auto range ban](https://docs.pbh-btn.com/docs/module/auto-range-ban)
+- [Multi-dail ban](https://docs.pbh-btn.com/docs/module/multi-dial)
+- Peer ID/Client Name camouflage check, powered by [AviatorScript Engine](https://docs.pbh-btn.com/docs/module/expression-engine)
+- [Active monitoring(data analysis)](https://docs.pbh-btn.com/docs/module/active-monitoring)
+- [IP set subscribe](https://docs.pbh-btn.com/docs/module/ip-address-blocker-rules)
+- a mordern WebUI 
+
+In addition, PeerBanHelper downloads the GeoIP library at startup, and supports the following functions once it successful loaded:
+- View IP address attribution, AS information (ASN, ISP, AS name, etc.), network type information (broadband, base station, IoT, data center, etc.) in the blocking list.
+- Based on GeoIP information, block IP addresses by country/region, city, network type, ASN and so on.
+- View GeoIP statistics
 
 > [!TIP]
-> 为获得最佳效果，建议配合我们维护的 IP 规则库 [PBH-BTN/BTN-Collected-Rules](https://github.com/PBH-BTN/BTN-Collected-Rules) 和 [BTN 网络](https://docs.pbh-btn.com/docs/btn/intro) 一起食用，不过这是完全可选的。
-
-| 主界面                                                                                                                                | 封禁列表                                                                                                                             | 封禁日志                                                                                                                             | 封禁统计                                                                                                                            | 规则统计                                                                                                                                | 规则订阅                                                                                                                                |
-| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
-| <img width="1280" alt="homepage" src="https://github.com/PBH-BTN/PeerBanHelper/assets/19235246/d7f7ea9f-70df-40f1-a782-260450972bc9"> | <img width="1280" alt="banlist" src="https://github.com/PBH-BTN/PeerBanHelper/assets/19235246/c3e139e6-eb82-423f-b083-1839713ec801"> | <img width="1280" alt="banlogs" src="https://github.com/PBH-BTN/PeerBanHelper/assets/19235246/00d8efcc-0dd7-4e05-bdeb-9444e14739d6"> | <img width="1280" alt="maxban" src="https://github.com/PBH-BTN/PeerBanHelper/assets/30802565/ae78ebb9-67f7-481a-9afc-7ced2c6a2534"> | <img width="1280" alt="banMetrics" src="https://github.com/PBH-BTN/PeerBanHelper/assets/19235246/9e4cd7b7-aaff-4b66-8d1d-ad4ef3466b1f"> | <img width="1280" alt="banMetrics" src="https://github.com/PBH-BTN/PeerBanHelper/assets/19235246/dc312186-9643-4f23-9d53-7b8e0852f228"> |
+> For best results, it is recommended to work with the IP rule [PBH-BTN/BTN-Collected-Rules](https://github.com/PBH-BTN/BTN-Collected-Rules) and [BTN Network](https://docs.pbh-btn.com/docs/btn/intro) , but this is completely optional.
 
-## 安装 PeerBanHelper
 
-查看 [PeerBanHelper 文档](https://docs.pbh-btn.com/docs/category/%E5%AE%89%E8%A3%85%E9%83%A8%E7%BD%B2)
+## Supported clients
 
-## 支持的客户端
+- qBittorrent **4.5.0 or higher**
+- BiglyBT([plugin](https://github.com/PBH-BTN/PBH-Adapter-BiglyBT) is required)
+- Deluge([plugin](https://github.com/PBH-BTN/PBH-Adapter-Deluge) is required)
+- Azureus(Vuze)([plugin](https://github.com/PBH-BTN/PBH-Adapter-Azureus) is required)
+- Transmission **(deprected；3.00-20 or higher)**
+- BitComet **v2.10 Beta6 [20240928] or higher**
 
-- qBittorrent **4.5.0 或更高版本**
-- BiglyBT（需要安装[插件](https://github.com/PBH-BTN/PBH-Adapter-BiglyBT)）
-- Deluge（需要安装[插件](https://github.com/PBH-BTN/PBH-Adapter-Deluge)）
-- Azureus(Vuze)（需要安装[插件](https://github.com/PBH-BTN/PBH-Adapter-Azureus)）
-- Transmission **(不建议使用；3.00-20 或更高版本)**
-- BitComet **v2.10 Beta6 [20240928] 或更高版本**
+
+# Screenshots
 
-## 注意事项
+| Dashboard                                                                                                                             | Banlist                                                                                                                              | Banlogs                                                                                                                              | Rule subscribe                                                                                                                          |
+| :------------------------------------------------------------------------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- |
+| <img width="1280" alt="homepage" src="https://github.com/PBH-BTN/PeerBanHelper/assets/19235246/d7f7ea9f-70df-40f1-a782-260450972bc9"> | <img width="1280" alt="banlist" src="https://github.com/PBH-BTN/PeerBanHelper/assets/19235246/c3e139e6-eb82-423f-b083-1839713ec801"> | <img width="1280" alt="banlogs" src="https://github.com/PBH-BTN/PeerBanHelper/assets/19235246/00d8efcc-0dd7-4e05-bdeb-9444e14739d6"> | <img width="1280" alt="banMetrics" src="https://github.com/PBH-BTN/PeerBanHelper/assets/19235246/dc312186-9643-4f23-9d53-7b8e0852f228"> |
 
-请不要打开下载器中的 "允许来自同一 IP 地址的多个连接" 选项，这会干扰 PBH 计算数据，并导致错误封禁。  
-如果您的下载器存在 PT 站种子，在添加下载器时建议开启 “忽略私有种子”。
+## Install
 
-## 功能介绍
+Please read the [docs](https://docs.pbh-btn.com/docs/category/%E5%AE%89%E8%A3%85%E9%83%A8%E7%BD%B2)
 
-PeerBanHelper 主要由以下几个功能模块组成：
 
-- [PeerID 黑名单](https://docs.pbh-btn.com/docs/module/peer-id)
-- [Client Name 黑名单](https://docs.pbh-btn.com/docs/module/client-name)
-- [IP/GeoIP/IP 类型 黑名单](https://docs.pbh-btn.com/docs/module/ip-address-blocker)
-- [虚假进度检查器（提供启发式客户端检测功能）](https://docs.pbh-btn.com/docs/module/progress-cheat-blocker)
-- [自动连锁封禁](https://docs.pbh-btn.com/docs/module/auto-range-ban)
-- [多拨追猎](https://docs.pbh-btn.com/docs/module/multi-dial)
-- Peer ID/Client Name 伪装检查；通过 [AviatorScript 引擎](https://docs.pbh-btn.com/docs/module/expression-engine) 实现
-- [主动监测（提供本地数据分析功能）](https://docs.pbh-btn.com/docs/module/active-monitoring)
-- [网络 IP 集规则订阅](https://docs.pbh-btn.com/docs/module/ip-address-blocker-rules)
-- WebUI （目前支持：活跃封禁名单查看，历史封禁查询，封禁最频繁的 Top 50 IP，规则订阅管理，图表查看，Peer 列表查看）
+## FAQ
 
-此外，PeerBanHelper 会在启动时下载 GeoIP 库，成功加载后支持以下功能：
+Before submit issue, please read the [FAQ](https://docs.pbh-btn.com/docs/faq)
 
-- 在封禁列表中查看 IP 归属地，AS 信息（ASN、ISP、AS 名称等），网络类型信息（宽带、基站、物联网、数据中心等）
-- 基于 GeoIP 信息按国家/地区、城市、网络类型、ASN 等封禁 IP 地址
-- 查看 GeoIP 统计数据
+## Declaration
 
-## 常见问题
-
-在报告问题前，请先检查 [常见问题列表](https://docs.pbh-btn.com/docs/faq)
-
-## Install4j
-
-PeerBanHelper 使用 [Install4j multi-platform installer builder](https://www.ej-technologies.com/products/install4j/overview.html) 打包多平台安装程序。感谢 ej-technolgies 的开放源代码许可证。点击链接或者下面的图片下载 install4j。
-
-[![Install4j](https://www.ej-technologies.com/images/product_banners/install4j_large.png)](https://www.ej-technologies.com/products/install4j/overview.html)
-
-## 法律文本
-
-违法网站和黑灰产请勿向我组织开发或支持人员发起任何形式的人工服务请求；严禁使用 PBH-BTN 团队的任何服务、产品从事任何违法违规、危害国家安全、实施或帮助他人实施电信犯罪等非法活动。  
-用户不得通过 PBH-BTN 团队的任何服务、产品进行任何损害其它个人或组织的利益的活动。在任何违反个人或组织权益的情况下使用 PBH-BTN 团队的任何服务、产品均不被允许。
+Illegal websites and black and grey industries should not initiate any kind of manual service request to our organization's development or support staff; it is strictly prohibited to use any services or products of PBH-BTN team to engage in any illegal activities such as violating the law, endangering national security, committing or helping others to commit telecommunication crimes, and other illegal activities.  
+Users are not allowed to carry out any activities that harm the interests of other individuals or organizations through any services or products of PBH-BTN Team. The use of any PBH-BTN Team services or products in violation of the rights and interests of any individual or organization is not permitted.
 
 ## Star History
 
@@ -99,3 +85,9 @@ PeerBanHelper 使用 [Install4j multi-platform installer builder](https://www.ej
 - [Vue](https://vuejs.org/)
 - [ArcoDesign](https://arco.design/)
 - [ECharts](https://echarts.apache.org/en/index.html)
+
+### Install4j
+
+PeerBanHelper use [Install4j multi-platform installer builder](https://www.ej-technologies.com/products/install4j/overview.html) to build its multi-platform installer. Thanks the open-source license provided by ej-technolgies. Click the link or the image below to download install4j.
+
+[![Install4j](https://www.ej-technologies.com/images/product_banners/install4j_large.png)](https://www.ej-technologies.com/products/install4j/overview.html)