Skip to content

Commit bfdaae9

Browse files
committed
docs: add special instructions
1 parent a5a2584 commit bfdaae9

File tree

2 files changed

+22
-9
lines changed

2 files changed

+22
-9
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ x-crawl is an open source project under the MIT license, completely free to use.
134134
- [Community](#community)
135135
- [Issues](#issues)
136136
- [Sponsor](#sponsor-1)
137+
- [Special Instructions](#special-instructions)
137138

138139
## Install
139140

@@ -938,7 +939,7 @@ const myXCrawl = xCrawl()
938939
myXCrawl
939940
.crawlPage({
940941
url: 'https://www.example.com',
941-
proxy: 'xxx',
942+
proxy: { urls: ['xxx'] },
942943
maxRetry: 1
943944
})
944945
.then((res) => {})
@@ -1089,7 +1090,7 @@ const myXCrawl = xCrawl()
10891090
myXCrawl
10901091
.crawlHTML({
10911092
url: 'https://www.example.com',
1092-
proxy: 'xxx',
1093+
proxy: { urls: ['xxx'] },
10931094
maxRetry: 1
10941095
})
10951096
.then((res) => {})
@@ -1246,7 +1247,7 @@ const myXCrawl = xCrawl()
12461247
myXCrawl
12471248
.crawlData({
12481249
url: 'https://www.example.com/api',
1249-
proxy: 'xxx',
1250+
proxy: { urls: ['xxx'] },
12501251
maxRetry: 1
12511252
})
12521253
.then((res) => {})
@@ -1385,7 +1386,7 @@ const myXCrawl = xCrawl()
13851386
myXCrawl
13861387
.crawlFile({
13871388
url: 'https://www.example.com/file',
1388-
proxy: 'xxx',
1389+
proxy: { urls: ['xxx'] },
13891390
maxRetry: 1,
13901391
storeDir: './upload',
13911392
fileName: 'xxx'
@@ -2042,10 +2043,16 @@ The crawlPage API has built-in [puppeteer](https://github.com/puppeteer/puppetee
20422043
20432044
- **GitHub Discussions:** Use [GitHub Discussions](https://github.com/coder-hxl/x-crawl/discussions) for message board-style questions and discussions.
20442045
2046+
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.
2047+
20452048
### Issues
20462049
20472050
If you have questions, needs, or good suggestions, you can raise them at [GitHub Issues](https://github.com/coder-hxl/x-crawl/issues).
20482051
20492052
### Sponsor
20502053
20512054
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.
2055+
2056+
### Special Instructions
2057+
2058+
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.

docs/cn.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ x-crawl 是采用 MIT 许可的开源项目,使用完全免费。如果你在
134134
- [社区](#社区)
135135
- [Issues](#Issues)
136136
- [赞助](#赞助-1)
137+
- [特殊说明](#特殊说明)
137138

138139
## 安装
139140

@@ -930,7 +931,7 @@ const myXCrawl = xCrawl()
930931
myXCrawl
931932
.crawlPage({
932933
url: 'https://www.example.com',
933-
proxy: 'xxx',
934+
proxy: { urls: ['xxx'] },
934935
maxRetry: 1
935936
})
936937
.then((res) => {})
@@ -1076,7 +1077,7 @@ const myXCrawl = xCrawl()
10761077
myXCrawl
10771078
.crawlHTML({
10781079
url: 'https://www.example.com',
1079-
proxy: 'xxx',
1080+
proxy: { urls: ['xxx'] },
10801081
maxRetry: 1
10811082
})
10821083
.then((res) => {})
@@ -1234,7 +1235,7 @@ const myXCrawl = xCrawl()
12341235
myXCrawl
12351236
.crawlData({
12361237
url: 'https://www.example.com/api',
1237-
proxy: 'xxx',
1238+
proxy: { urls: ['xxx'] },
12381239
maxRetry: 1
12391240
})
12401241
.then((res) => {})
@@ -1373,7 +1374,7 @@ const myXCrawl = xCrawl()
13731374
myXCrawl
13741375
.crawlFile({
13751376
url: 'https://www.example.com/file',
1376-
proxy: 'xxx',
1377+
proxy: { urls: ['xxx'] },
13771378
maxRetry: 1,
13781379
storeDir: './upload',
13791380
fileName: 'xxx'
@@ -2027,13 +2028,18 @@ crawlPage API 内置了 [puppeteer](https://github.com/puppeteer/puppeteer) ,
20272028
### 社区
20282029
20292030
- **Discord 聊天:** 通过 [Discord](https://discord.gg/SF7aaebg4E) 与其他 x-crawl 用户实时提问和讨论。
2030-
20312031
- **GitHub 讨论:** 使用 [GitHub 讨论](https://github.com/coder-hxl/x-crawl/discussions) 来进行留言板式的问题和讨论。
20322032
2033+
不得提交与非法活动相关的问题和讨论。x-crawl 仅供合法用途。禁止使用该工具进行任何违法活动,包括但不限于未经授权的数据采集、网络攻击、隐私侵犯等。
2034+
20332035
### Issues
20342036
20352037
如果您有 **问题 、需求、好的建议** 可以在 [GitHub Issues](https://github.com/coder-hxl/x-crawl/issues) 中提 **Issues** 。
20362038
20372039
### 赞助
20382040
20392041
x-crawl 是采用 MIT 许可的开源项目,使用完全免费。如果你在工作中受益于我开发维护的项目,请考虑通过 [爱发电](https://afdian.net/a/coderhxl) 平台来支持一下我的工作。
2042+
2043+
### 特殊说明
2044+
2045+
x-crawl 仅供合法用途。禁止使用该工具进行任何违法活动,包括但不限于未经授权的数据采集、网络攻击、隐私侵犯等。

0 commit comments

Comments
 (0)