diff --git a/README.md b/README.md index ff5514c1c05..2ca8e782151 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,18 @@ npm i puppeteer Note: When you install Puppeteer, it downloads a recent version of Chromium (~170Mb Mac, ~282Mb Linux, ~280Mb Win) that is guaranteed to work with the API. To skip the download, see [Environment variables](https://github.com/GoogleChrome/puppeteer/blob/v1.7.0/docs/api.md#environment-variables). + +### puppeteer-core + +Since version 1.7.0 we publish the [`puppeteer-core`](https://www.npmjs.com/package/puppeteer-core) package, +a version of Puppeteer that doesn't download Chromium by default. + +```bash +npm i puppeteer-core +``` + +`puppeteer-core` is intended to be a lightweight version of puppeteer for launching an existing browser installation or for connecting to a remote one. + ### Usage Note: Puppeteer requires at least Node v6.4.0, but the examples below use async/await which is only supported in Node v7.6.0 or greater. diff --git a/docs/api.md b/docs/api.md index d347a8e8a77..c55e9e6b338 100644 --- a/docs/api.md +++ b/docs/api.md @@ -313,6 +313,8 @@ If puppeteer doesn't find them in the environment, a lowercased variant of these - `PUPPETEER_DOWNLOAD_HOST` - overwrite host part of URL that is used to download Chromium - `PUPPETEER_CHROMIUM_REVISION` - specify a certain version of chrome you'd like puppeteer to use during the installation step. +> **NOTE** PUPPETEER_* env variables are not accounted for in the [`puppeteer-core`](https://www.npmjs.com/package/puppeteer-core) package. + ### Error handling Puppeteer methods might throw errors if they are unable to fufill a request. For example, [page.waitForSelector(selector[, options])](#pagewaitforselectorselector-options)