github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(api.md): add an include statement for puppeteer-core (#3213)

Browse Source 
Fix #3204
This commit is contained in:
Divyansh Tripathi 2018-09-07 15:16:59 +05:30 committed by Andrey Lushnikov
parent c5511ecb81
commit c967aebc84
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api.md
View File

@ -339,6 +339,12 @@ However, you should use `puppeteer-core` if:
- you're building another end-user product or library atop of DevTools protocol. For example, one might build PDF generator using `puppeteer-core` and write a custom `install.js` script that downloads [`headless_shell`](https://chromium.googlesource.com/chromium/src/+/lkgr/headless/README.md) instead of Chromium to save disk space.
- you're bundling Puppeteer to use in Chrome Extension / browser with the DevTools protocol where downloading an additional Chromium binary is unnecessary.
When using `puppeteer-core`, remember to change the *include* line:
```js
const puppeteer = require('puppeteer-core');
```
### Environment Variables