完善 README.md #715
完善 README.md #715
Conversation
WalkthroughThe pull request includes significant updates to the Changes
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (7)
README.md (1)
54-54: Add more details about the WebUI feature.The WebUI feature is listed without any description of its capabilities. Consider adding a brief description or linking to documentation about its features, similar to how other modules are documented with links.
Example addition:
- WebUI + [WebUI](https://docs.pbh-btn.com/docs/module/webui) - 提供封禁列表查看和历史封禁查询功能README-en.md (6)
9-11: Fix blockquote formatting.The blockquotes contain unnecessary blank lines that can be removed to comply with markdown best practices.
Apply this diff:
> [!NOTE] -> PeerBanHelper does not have a built-in update checker. Remember to check back regularly for new version updates, or Watch this repository (Custom -> Releases, Issues, and Discussions) to receive update notifications. -> QQ Group: 932978658. If you need help during usage, you can communicate with others here. Alternatively, you can open a new issue in the [Issue Tracker](https://github.com/Ghost-chu/PeerBanHelper/issues). +> PeerBanHelper does not have a built-in update checker. Remember to check back regularly for new version updates, or Watch this repository (Custom -> Releases, Issues, and Discussions) to receive update notifications. +> QQ Group: 932978658. If you need help during usage, you can communicate with others here. Alternatively, you can open a new issue in the [Issue Tracker](https://github.com/Ghost-chu/PeerBanHelper/issues). > [!TIP] -> PeerBanHelper will work properly as long as it is correctly connected to your downloader. In most cases, no additional configuration is required. +> PeerBanHelper will work properly as long as it is correctly connected to your downloader. In most cases, no additional configuration is required. > [!TIP] -> For best results, it is recommended to use it with our maintained IP rule library [PBH-BTN/BTN-Collected-Rules](https://github.com/PBH-BTN/BTN-Collected-Rules) and the [BTN Network](https://docs.pbh-btn.com/docs/btn/intro), although this is entirely optional. +> For best results, it is recommended to use it with our maintained IP rule library [PBH-BTN/BTN-Collected-Rules](https://github.com/PBH-BTN/BTN-Collected-Rules) and the [BTN Network](https://docs.pbh-btn.com/docs/btn/intro), although this is entirely optional.Also applies to: 13-15, 16-18
19-21: Enhance image accessibility with more descriptive alt text.The current alt text uses generic terms like "homepage" and "banlist". Consider using more descriptive alt text that explains what each screenshot shows.
Example improvements:
- "PeerBanHelper dashboard showing status overview"
- "Ban list interface displaying blocked peers"
- "Ban logs showing recent blocking activity"
- "Ban ranks displaying most frequently blocked clients"
- "Rule statistics showing ban metrics and patterns"
- "Rule subscription management interface"
33-34: Clarify why Transmission is not recommended.The documentation marks Transmission as "not recommended" but doesn't explain why. This information would help users make an informed decision about their client choice.
Consider adding a brief explanation in parentheses, for example:
-Transmission **(not recommended; version 3.00-20 or higher)** +Transmission **(not recommended due to limited API capabilities; version 3.00-20 or higher)**
36-40: Enhance visibility of important configuration warnings.Consider using GitHub's alert syntax to make these critical configuration notes more prominent.
Apply this diff:
-## Important Notes - -Please do not enable the "Allow multiple connections from the same IP address" option in your downloader, as this can interfere with PBH's data calculation and result in incorrect bans. -If your downloader contains seeds from PT sites, it is recommended to enable "Ignore private seeds" when adding the downloader. +## Important Notes + +> [!WARNING] +> Please do not enable the "Allow multiple connections from the same IP address" option in your downloader, as this can interfere with PBH's data calculation and result in incorrect bans. + +> [!TIP] +> If your downloader contains seeds from PT sites, it is recommended to enable "Ignore private seeds" when adding the downloader.
43-61: Improve feature list organization.Consider grouping related features into categories for better readability.
Example structure:
PeerBanHelper includes the following feature categories: ### Core Protection Features - PeerID Blacklist - Client Name Blacklist - False Progress Checker - Peer ID/Client Name Spoofing Check ### Network Protection - IP/GeoIP/IP Type Blacklist - Automatic Chain Banning - Multi-Dial Hunting - Network IP Set Rule Subscription ### Monitoring & Analysis - Active Monitoring - WebUI - GeoIP Features - IP location and AS information - GeoIP-based banning - GeoIP statistics
74-75: Enhance legal text formatting and tone.The legal text would benefit from a more formal structure and consistent tone.
Suggested revision:
## Legal Disclaimer 1. **Prohibited Usage**: The use of PBH-BTN team's services and products is strictly prohibited for: - Illegal websites and gray/black hat operations - Activities that endanger national security - Telecommunications crimes or assistance thereof 2. **User Obligations**: Users must not utilize PBH-BTN team's services or products to: - Harm the interests of individuals or organizations - Violate any rights or interests protected by law Any violation of these terms will result in immediate termination of service access.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
README-en.md(1 hunks)README.md(3 hunks)
🧰 Additional context used
🪛 Markdownlint
README-en.md
12-12: null
Blank line inside blockquote
(MD028, no-blanks-blockquote)
15-15: null
Blank line inside blockquote
(MD028, no-blanks-blockquote)
🔇 Additional comments (2)
README.md (2)
81-82: LGTM: Credits section header formatting.
The "Credits" section header and its subsections are properly formatted.
1-1: Verify language switcher implementation.
The language switcher links appear correct, but let's verify the corresponding English version exists and is properly linked.
✅ Verification successful
Language switcher implementation is correctly implemented
The verification confirms that:
- README-en.md exists
- The English version contains the correct reciprocal language switcher link
- Both files properly reference each other with correct relative paths
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify the existence and proper linking of README-en.md
if [ -f "README-en.md" ]; then
echo "README-en.md exists"
# Check if README-en.md contains the reciprocal language switcher
grep -A 1 "\[简体中文\]" README-en.md
else
echo "WARNING: README-en.md is missing"
fi
Length of output: 159
|
感谢你的完善，但是我们打算剪裁readme中的内容，并将安装的部分内容替换为链接到文档的超链接 |
可否稍微详细描述一下？我可以帮忙修改 |
|
同样的内容只维护一份原则，可以看看pbh-btn组织下的pbh-doc仓库
举例：pbh的安装方式已经在pbh-doc中提供了，就不要再readme里面进行重复，而是直接替换为指向doc的超链接
另：英文翻译可以在完成剪裁后使用gpt+人工润色来进行，目前的机翻我看质量不是很好
…--------------原始邮件--------------
发件人："CreeperAWA ***@***.***>;
发送时间：2024年11月10日(星期天) 下午2:19
收件人："PBH-BTN/PeerBanHelper" ***@***.***>;
抄送："高渐离 ***@***.***>;"Comment ***@***.***>;
主题：Re: [PBH-BTN/PeerBanHelper] 完善 README.md (PR #715)
-----------------------------------
感谢你的完善，但是我们打算剪裁readme中的内容，并将安装的部分内容替换为链接到文档的超链接
可否稍微详细描述一下？我可以帮忙修改
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you commented.Message ID: ***@***.***>
|
这个翻译是文心一言，可能英文方面不及GPT( |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
README.md (2)
43-44: Consider making the FAQ section more concise.The section currently repeats the same link twice. Consider combining the lines into a single, clear message.
-[常见问题列表](https://docs.pbh-btn.com/docs/faq) -在报告问题前，也请您先检查[常见问题列表](https://docs.pbh-btn.com/docs/faq)，看看您遇到的问题是否已经涵盖在了该列表中 +在报告问题前，请先查看[常见问题列表](https://docs.pbh-btn.com/docs/faq)，确认您遇到的问题是否已有解答
Line range hint
1-83: Consider adding a table of contents for better navigation.The README is well-structured, but given its length and various sections, a table of contents would improve navigation, especially for first-time visitors.
Consider adding a table of contents after the language selector, like this:
## 目录 - [简介](#peerbanhelper) - [安装](#安装-peerbanhelper) - [支持的客户端](#支持的客户端) - [功能介绍](#功能介绍) - [常见问题](#常见问题) - [Install4j](#install4j) - [法律文本](#法律文本) - [Star History](#star-history) - [Credits](#credits)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
README.md(4 hunks)
🔇 Additional comments (5)
README.md (5)
Line range hint 1-27: LGTM! Well-structured bilingual navigation and introduction.
The language selector, introduction, and screenshot gallery effectively present the tool's key features and important notices to users.
28-32: LGTM! Successfully implemented the requested documentation linking.
The installation and supported clients sections now correctly link to the documentation instead of duplicating content, following the principle of maintaining a single source of truth.
Line range hint 33-42: LGTM! Good balance of documentation links and essential information.
The features section effectively combines documentation links with important GeoIP functionality details that users should know upfront.
Line range hint 45-60: LGTM! Appropriate acknowledgment of Install4j.
The section properly credits Install4j and provides necessary information about the installer builder.
Line range hint 61-83: LGTM! Well-organized credits section.
The credits section clearly lists and categorizes all dependencies, properly acknowledging both backend and frontend libraries.
|
不太对。。。我来改吧 |
我完善了一下中文的 README.md，并机翻了一份英文 README.md
我对机翻后的英文 README.md 也做出了一些修改，使其更加完美，如果仍有问题，请告诉我，我会再次修改
Summary by CodeRabbit