Skip to content

Commit 48b20ca

Browse files
committed
docs: update usage precautions
1 parent 1122eab commit 48b20ca

File tree

2 files changed

+22
-15
lines changed

2 files changed

+22
-15
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ x-crawl is a flexible Node.js multifunctional crawler library. Flexible usage an
2222

2323
## Sponsor
2424

25-
x-crawl is an open source project under the MIT license, completely free to use. If you benefit from the projects I develop and maintain at work, please consider supporting my work through the [Afdian](https://afdian.net/a/coderhxl) platform.
25+
x-crawl is an open source project licensed by MIT and is completely free to use. If you benefit from the projects I develop and maintain at work, so that I can continue to devote energy to the maintenance and update of the project and improve the user experience and functions, please consider using [Afdian](https://afdian.net/a/coderhxl) platform to support my work. Your support is the driving force for our continuous improvement! thank you for your support!
2626

2727
# Table of Contents
2828

@@ -136,7 +136,7 @@ x-crawl is an open source project under the MIT license, completely free to use.
136136
- [Community](#community)
137137
- [Issues](#issues)
138138
- [Sponsor](#sponsor-1)
139-
- [Special Instructions](#special-instructions)
139+
- [Precautions](#Precautions)
140140

141141
## Install
142142

@@ -203,7 +203,7 @@ running result:
203203
<img src="https://raw.githubusercontent.com/coder-hxl/x-crawl/main/assets/run-example.gif" />
204204
</div>
205205

206-
**Note:** Please do not crawl randomly, you can check the **robots.txt** protocol before crawling. The class name of the website may change, this is just to demonstrate how to use x-crawl.
206+
**Note:** x-crawl is for legal purposes only. It is prohibited to use this tool for any illegal activities. Please be sure to comply with the robots.txt file regulations of the target website. The class name of the website may change at any time. This example is only used to demonstrate the use of x-crawl and is not specific to a specific website.
207207

208208
## Core Concepts
209209

@@ -2106,16 +2106,20 @@ myXCrawl.crawlPage({
21062106
21072107
- **GitHub Discussions:** Use [GitHub Discussions](https://github.com/coder-hxl/x-crawl/discussions) for message board-style questions and discussions.
21082108
2109-
Questions and discussions related to illegal activities may not be submitted. x-crawl is for legal use only. It is prohibited to use this tool to conduct any illegal activities, including but not limited to unauthorized data collection, cyber attacks, privacy invasion, etc.
2109+
Questions and discussions related to any illegal activity may not be submitted. x-crawl is for legal purposes only, and it is prohibited to use this tool to conduct any illegal activities, including but not limited to unauthorized data collection, network attacks, privacy violations, etc. Please ensure that your usage behavior always complies with laws, regulations and ethical standards, and jointly maintain a safe and legal network environment.
21102110
21112111
### Issues
21122112
21132113
If you have questions, needs, or good suggestions, you can raise them at [GitHub Issues](https://github.com/coder-hxl/x-crawl/issues).
21142114
21152115
### Sponsor
21162116
2117-
x-crawl is an open source project under the MIT license, completely free to use. If you benefit from the projects I develop and maintain at work, please consider supporting my work through the [Afdian](https://afdian.net/a/coderhxl) platform.
2117+
x-crawl is an open source project licensed by MIT and is completely free to use. If you benefit from the projects I develop and maintain at work, so that I can continue to devote energy to the maintenance and update of the project and improve the user experience and functions, please consider using [Afdian](https://afdian.net/a/coderhxl) platform to support my work. Your support is the driving force for our continuous improvement! thank you for your support!
21182118
2119-
### Special Instructions
2119+
### Precautions
21202120
2121-
x-crawl is for legal use only. It is prohibited to use this tool to conduct any illegal activities, including but not limited to unauthorized data collection, cyber attacks, privacy invasion, etc.
2121+
- x-crawl is for legal purposes only. It is prohibited to use this tool to conduct any illegal activities, including but not limited to unauthorized data collection, network attacks, privacy violations, etc.
2122+
- Before collecting data, make sure you have explicit authorization from the target website and comply with its robots.txt file and terms of use.
2123+
- Avoid placing excessive access pressure on the target website to avoid triggering its anti-crawling strategy or causing server downtime.
2124+
2125+
**x-crawl is for legal purposes only, x-crawl does not bear any responsibility for any legal liability arising from the use of x-crawl**

docs/cn.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ x-crawl 是一个灵活的 Node.js 多功能爬虫库。灵活的使用方式和
2222

2323
## 赞助
2424

25-
x-crawl 是采用 MIT 许可的开源项目,使用完全免费。如果你在工作中受益于我开发维护的项目,请考虑通过 [爱发电](https://afdian.net/a/coderhxl) 平台来支持一下我的工作。
25+
x-crawl 是采用 MIT 许可的开源项目,使用完全免费。如果您在工作中受益于我开发维护的项目,为了让我能够持续投入精力进行项目的维护与更新,提升用户体验和功能,请考虑通过 [爱发电](https://afdian.net/a/coderhxl) 平台来支持一下我的工作。您的支持是我们持续改进的动力!感谢您的支持!
2626

2727
# 目录
2828

@@ -136,7 +136,7 @@ x-crawl 是采用 MIT 许可的开源项目,使用完全免费。如果你在
136136
- [社区](#社区)
137137
- [Issues](#Issues)
138138
- [赞助](#赞助-1)
139-
- [特殊说明](#特殊说明)
139+
- [注意事项](#注意事项)
140140

141141
## 安装
142142

@@ -199,8 +199,7 @@ myXCrawl.startPolling({ d: 1 }, async (count, stopPolling) => {
199199
<div align="center">
200200
<img src="https://raw.githubusercontent.com/coder-hxl/x-crawl/main/assets/run-example.gif" />
201201
</div>
202-
203-
**注意:** 请勿随意爬取,爬取前可查看 **robots.txt** 协议。网站的类名可能会有变更,这里只是为了演示如何使用 x-crawl 。
202+
**注意:** x-crawl 仅供合法用途,禁止使用该工具进行任何违法活动,请务必遵守目标网站的 robots.txt 文件规定。网站的类名可能随时发生变更,本例仅用于演示 x-crawl 的使用方法,并非针对特定网站。
204203

205204
## 核心概念
206205

@@ -2093,16 +2092,20 @@ myXCrawl.crawlPage({
20932092
- **Discord 聊天:** 通过 [Discord](https://discord.gg/SF7aaebg4E) 与其他 x-crawl 用户实时提问和讨论。
20942093
- **GitHub 讨论:** 使用 [GitHub 讨论](https://github.com/coder-hxl/x-crawl/discussions) 来进行留言板式的问题和讨论。
20952094
2096-
不得提交与非法活动相关的问题和讨论。x-crawl 仅供合法用途禁止使用该工具进行任何违法活动,包括但不限于未经授权的数据采集、网络攻击、隐私侵犯等
2095+
不得提交与任何非法活动相关的问题和讨论。x-crawl 仅供合法用途禁止使用该工具进行任何违法活动,包括但不限于未经授权的数据采集、网络攻击、隐私侵犯等行为。请确保您的使用行为始终符合法律法规和道德标准,共同维护一个安全、合法的网络环境
20972096
20982097
### Issues
20992098
21002099
如果您有 **问题 、需求、好的建议** 可以在 [GitHub Issues](https://github.com/coder-hxl/x-crawl/issues) 中提 **Issues** 。
21012100
21022101
### 赞助
21032102
2104-
x-crawl 是采用 MIT 许可的开源项目,使用完全免费。如果你在工作中受益于我开发维护的项目,请考虑通过 [爱发电](https://afdian.net/a/coderhxl) 平台来支持一下我的工作。
2103+
x-crawl 是采用 MIT 许可的开源项目,使用完全免费。如果您在工作中受益于我开发维护的项目,为了让我能够持续投入精力进行项目的维护与更新,提升用户体验和功能,请考虑通过 [爱发电](https://afdian.net/a/coderhxl) 平台来支持一下我的工作。您的支持是我们持续改进的动力!感谢您的支持!
2104+
2105+
### 注意事项
21052106
2106-
### 特殊说明
2107+
- x-crawl 仅供合法用途,禁止使用该工具进行任何违法活动,包括但不限于未经授权的数据采集、网络攻击、隐私侵犯等行为。
2108+
- 在进行数据采集之前,请确保您已经获得了目标网站的明确授权,并遵守其 robots.txt 文件规定以及使用条款。
2109+
- 避免对目标网站造成过大的访问压力,以免触发其反爬策略或造成服务器宕机。
21072110
2108-
x-crawl 仅供合法用途。禁止使用该工具进行任何违法活动,包括但不限于未经授权的数据采集、网络攻击、隐私侵犯等。
2111+
**x-crawl 仅供合法用途,任何因使用 x-crawl 而引起的法律责任,x-crawl 不承担任何责任**

0 commit comments

Comments
 (0)