Skip to content

Commit

Permalink
docs(pptrfx): update readme (#3633)
Browse files Browse the repository at this point in the history
  • Loading branch information
aslushnikov committed Dec 6, 2018
1 parent b874529 commit be836be
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
12 changes: 10 additions & 2 deletions experimental/puppeteer-firefox/README.md
@@ -1,3 +1,5 @@
<img src="https://user-images.githubusercontent.com/39191/49555713-a07b3c00-f8b5-11e8-8aba-f2d03cd83da5.png" height="200" align="right">

# Puppeteer for Firefox

> Use Puppeteer's API with Firefox
Expand All @@ -15,7 +17,7 @@ npm i puppeteer-firefox
# or "yarn add puppeteer-firefox"
```

Note: When you install puppeteer-firefox, it downloads a [custom-built Firefox](https://github.com/GoogleChrome/puppeteer/tree/master/experimental/juggler) that is guaranteed to work with the API.
Note: When you install puppeteer-firefox, it downloads a [custom-built Firefox](https://github.com/GoogleChrome/puppeteer/tree/master/experimental/juggler) (Firefox/63.0.4) that is guaranteed to work with the API.

### Usage

Expand Down Expand Up @@ -44,6 +46,12 @@ node example.js

### API Status

Big lacking parts:
- `page.emulate`
- `page.pdf`
- all network-related APIs: `page.on('request')`, `page.on('response')`, and request interception


- class: Puppeteer
* puppeteer.executablePath()
* puppeteer.launch([options])
Expand Down Expand Up @@ -184,4 +192,4 @@ node example.js
- class: TimeoutError


Special thanks to [Amine Zaza](https://bitbucket.org/aminerop/) who volunteered the [`puppeteer-firefox`](https://www.npmjs.com/package/puppeteer-firefox) NPM package.
Special thanks to [Amine Bouhlali](https://bitbucket.org/aminerop/) who volunteered the [`puppeteer-firefox`](https://www.npmjs.com/package/puppeteer-firefox) NPM package.
2 changes: 1 addition & 1 deletion experimental/puppeteer-firefox/package.json
@@ -1,6 +1,6 @@
{
"name": "puppeteer-firefox",
"version": "0.4.0",
"version": "0.4.1",
"description": "Puppeteer API for Firefox",
"main": "index.js",
"repository": "github:GoogleChrome/puppeteer",
Expand Down

0 comments on commit be836be

Please sign in to comment.