From c967aebc8404a6747f1b9dc67f439594c5b09e2c Mon Sep 17 00:00:00 2001 From: Divyansh Tripathi Date: Fri, 7 Sep 2018 15:16:59 +0530 Subject: [PATCH] docs(api.md): add an include statement for puppeteer-core (#3213) Fix #3204 --- docs/api.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api.md b/docs/api.md index bf1e2aed1c5..844ba41f47a 100644 --- a/docs/api.md +++ b/docs/api.md @@ -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