Skip to content

Commit d81b885

Browse files
committed
docs: add sponsorship and FAQ
1 parent 29f7817 commit d81b885

File tree

2 files changed

+30
-6
lines changed

2 files changed

+30
-6
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ x-crawl is a flexible Node.js multifunctional crawler library. Flexible usage an
2121
- **🧾 Capture Record** - Capture and record crawling, and use colored strings to remind in the terminal.
2222
- **🦾 TypeScript** - Own types, implement complete types through generics.
2323

24-
## Relationship with Puppeteer
24+
## Sponsor
2525

26-
The crawlPage API has built-in [puppeteer](https://github.com/puppeteer/puppeteer), you only need to pass in some configuration options to let x-crawl help you complete some operations, and the result will expose the Brower instance and the Page instance Come out, the Brower instance and Page instance you get will be intact, and x-crawl will not rewrite them.
26+
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.
2727

2828
# Table of Contents
2929

@@ -115,9 +115,12 @@ The crawlPage API has built-in [puppeteer](https://github.com/puppeteer/puppetee
115115
- [CrawlFileSingleResult](#CrawlFileSingleResult)
116116
- [API Other](#API-Other)
117117
- [AnyObject](#AnyObject)
118+
- [FAQ](#FAQ)
119+
- [The relationship between crawlPage API and puppeteer](#The-relationship-between-crawlPage-API-and-puppeteer)
118120
- [More](#More)
119121
- [Community](#Community)
120122
- [Issues](#Issues)
123+
- [Sponsor](#Sponsor-1)
121124

122125
## Install
123126

@@ -1761,6 +1764,12 @@ export interface AnyObject extends Object {
17611764
}
17621765
```
17631766
1767+
## FAQ
1768+
1769+
### The relationship between crawlPage API and puppeteer
1770+
1771+
The crawlPage API has built-in [puppeteer](https://github.com/puppeteer/puppeteer), you only need to pass in some configuration options to let x-crawl help you simplify the operation and get the intact Brower instance and Page instance , x-crawl does not override it.
1772+
17641773
## More
17651774
17661775
### Community
@@ -1772,3 +1781,7 @@ export interface AnyObject extends Object {
17721781
### Issues
17731782
17741783
If you have questions, needs, or good suggestions, you can raise them at [GitHub Issues](https://github.com/coder-hxl/x-crawl/issues).
1784+
1785+
### Sponsor
1786+
1787+
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.

docs/cn.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ x-crawl 是一个灵活的 Node.js 多功能爬虫库。灵活的使用方式和
2121
- **🧾 捕获记录** - 对爬取进行捕获记录,并在终端使用彩色字符串提醒。
2222
- **🦾 TypeScript** - 拥有类型,通过泛型实现完整的类型。
2323

24-
## 跟 puppeteer 的关系
24+
## 赞助
2525

26-
crawlPage API 内置了 [puppeteer](https://github.com/puppeteer/puppeteer) ,您只需要传入一些配置选项即可让 x-crawl 帮助您完成一些操作,结果会将 Brower 实例和 Page 实例暴露出来,您拿到的 Brower 实例和 Page 实例将是完好的,x-crawl 并不会对其重写
26+
x-crawl 是采用 MIT 许可的开源项目,使用完全免费。如果你在工作中受益于我开发维护的项目,请考虑通过 [爱发电](https://afdian.net/a/coderhxl) 平台来支持一下我的工作
2727

2828
# 目录
2929

@@ -116,9 +116,12 @@ crawlPage API 内置了 [puppeteer](https://github.com/puppeteer/puppeteer) ,
116116
- [CrawlFileSingleResult](#CrawlFileSingleResult)
117117
- [API Other](#API-Other)
118118
- [AnyObject](#AnyObject)
119+
- [常见问题](#常见问题)
120+
- [crawlPage 跟 puppeteer 的关系](#crawlPage-跟-puppeteer-的关系)
119121
- [更多](#更多)
120122
- [社区](#社区)
121123
- [Issues](#Issues)
124+
- [赞助](#赞助-1)
122125

123126
## 安装
124127

@@ -1756,9 +1759,13 @@ export interface AnyObject extends Object {
17561759
}
17571760
```
17581761
1759-
## 更多
1762+
## 常见问题
17601763
1761-
### 社区
1764+
### crawlPage API 跟 puppeteer 的关系
1765+
1766+
crawlPage API 内置了 [puppeteer](https://github.com/puppeteer/puppeteer) ,您只需要传入一些配置选项即可让 x-crawl 帮助您简化操作,并拿到完好的 Brower 实例和 Page 实例,x-crawl 并不会对其重写。
1767+
1768+
## 更多
17621769
17631770
### 社区
17641771
@@ -1769,3 +1776,7 @@ export interface AnyObject extends Object {
17691776
### Issues
17701777
17711778
如果您有 **问题 、需求、好的建议** 可以在 [GitHub Issues](https://github.com/coder-hxl/x-crawl/issues) 中提 **Issues** 。
1779+
1780+
### 赞助
1781+
1782+
x-crawl 是采用 MIT 许可的开源项目,使用完全免费。如果你在工作中受益于我开发维护的项目,请考虑通过 [爱发电](https://afdian.net/a/coderhxl) 平台来支持一下我的工作。

0 commit comments

Comments
 (0)