-
Notifications
You must be signed in to change notification settings - Fork 4
/
.readme.hbs
79 lines (60 loc) · 2.85 KB
/
.readme.hbs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
[![Version](https://img.shields.io/npm/v/puppeteer-page-pool)](https://bit.ly/2KHg9rB)
[![Downloads](https://img.shields.io/npm/dt/puppeteer-page-pool)](https://bit.ly/2KHg9rB)
[![Dependency Status](https://img.shields.io/david/rickypc/puppeteer-page-pool)](https://bit.ly/2Tjx5YT)
[![Dev Dependency Status](https://img.shields.io/david/dev/rickypc/puppeteer-page-pool)](https://bit.ly/2YBkjev)
[![Code Style](https://img.shields.io/badge/code%20style-Airbnb-red)](https://bit.ly/2JYN1gk)
[![Build](https://img.shields.io/travis/rickypc/puppeteer-page-pool)](https://bit.ly/2YSR7il)
[![Coverage](https://img.shields.io/codecov/c/github/rickypc/puppeteer-page-pool)](https://bit.ly/2TmdMhN)
[![Vulnerability](https://img.shields.io/snyk/vulnerabilities/github/rickypc/puppeteer-page-pool)](https://bit.ly/2YLUoRq)
[![Dependabot](https://api.dependabot.com/badges/status?host=github&repo=rickypc/puppeteer-page-pool)](https://bit.ly/2KIM5vs)
[![License](https://img.shields.io/npm/l/puppeteer-page-pool)](https://bit.ly/2yi7gyO)
Puppeteer Page Pool
===================
A [Page](https://bit.ly/2Z2NKFK) resource [pool](https://bit.ly/2ZNrNav) for [Puppeteer](https://bit.ly/2KqtMwd). It can be used to reuse or throttle usage of the Puppeteer Page resource.
Installation
-
```bash
$ npm install --save puppeteer-page-pool
```
API Reference
-
{{#module name="puppeteer-page-pool"}}
{{>body~}}
{{>member-index~}}
{{>separator~}}
{{>members~}}
{{/module}}
Development Dependencies
-
You will need to install [Node.js](https://bit.ly/2SMCGXK) as a local development dependency. The `npm` package manager comes bundled with all recent releases of `Node.js`.
`npm install` will attempt to resolve any `npm` module dependencies that have been declared in the project’s `package.json` file, installing them into the `node_modules` folder.
```bash
$ npm install
```
Run Linter
-
To make sure we followed code style best practice, run:
```bash
$ npm run lint
```
Run Unit Tests
-
To make sure we did not break anything, let's run:
```bash
$ npm test
```
Contributing
-
If you would like to contribute code to Puppeteer Page Pool repository you can do so
through GitHub by forking the repository and sending a pull request.
If you do not agree to [Contribution Agreement](CONTRIBUTING.md), do not
contribute any code to Puppeteer Page Pool repository.
When submitting code, please make every effort to follow existing conventions
and style in order to keep the code as readable as possible. Please also include
appropriate test cases.
That's it! Thank you for your contribution!
License
-
Copyright (c) 2018 - 2020 Richard Huang.
This module is free software, licensed under: [GNU Affero General Public License (AGPL-3.0)](https://bit.ly/2yi7gyO).
Documentation and other similar content are provided under [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://bit.ly/2SMCRlS).