Commit Graph

62 Commits

Author SHA1 Message Date
Eric Bidelman
9b06ed28ae docs(README): updates to make d.g.c/web/ happy (#1773)
Adds devsite's comment markers so we can pull sections of the readme into the site.
We lose a few syntax highlighting sections here on github, but everything looks great on developers.google.com!
2018-01-11 00:28:36 -08:00
Michael Stillwell
7c9104e1bc docs(README): add note on features not supported by Chromium (#1572) 2018-01-08 15:01:17 -08:00
Karl Brown
63f7e38077 docs(README.md): Update docs to more clearly differentiate between Chromium and Chrome (#1574)
This patch clarifies the documentation to more clearly note that Puppeteer works with both Chromium (by default)
and Chrome.

Fixes #1516
2017-12-14 19:09:48 -08:00
Ilya Radchenko
380bb6a87f docs: use debug namespace instead of all namespaces (#1174)
This changes the debugging instructions to be specific to puppeteer, preventing new users (or those that copy-paste) from getting logs from other libraries that use the `debug` module.
2017-10-27 02:15:15 -07:00
Andrey Lushnikov
ce8a952044 refactor: migrate NavigatorWatcher to lifecycle events (#1141)
This patch:
- migrates navigation watcher to use protocol-issued lifecycle events.
- removes `networkIdleTimeout` and `networkIdleInflight` options for
  `page.goto` method
- adds a new `networkidle0` value to the waitUntil option of navigation
  methods

References #728.

BREAKING CHANGE:

As an implication of this new approach, the `networkIdleTimeout` and
`networkIdleInflight` options are no longer supported. Interested
clients should implement the behavior themselves using the `request` and
`response` events.
2017-10-23 18:10:59 -07:00
Andrey Lushnikov
9fab3fd3be chore(readme): use shields.io to display badges 2017-10-17 15:02:54 -07:00
Adi Prasetyo
d0513914e4 chore: Add windows CI (appveyor) (#1046)
This patch adds appveyor to make sure puppeteer works reliably on
windows.

Fixes #955
2017-10-16 11:47:21 -07:00
Andrey Lushnikov
f6255029bd feat(Console): Introduce ConsoleMessage type (#909)
This patch introduces ConsoleMessage type and starts dispatching
it for the 'console' event.

BREAKING CHANGE: this breaks the api of the 'console' event.

Fixes #744.
2017-09-29 11:27:22 -07:00
Eric Bidelman
ccf8fb1681 readme: add try-puppeteer link (#849) 2017-09-21 18:01:48 -07:00
cohesively
aa58f25bc1 doc: add await to browser.close in usage examples (#797)
browser.close returns a promise after f398e69, so it should be awaited.
2017-09-15 21:27:14 -07:00
Eric Bidelman
51a507b236 readme: add PUPPETEER_SKIP_CHROMIUM_DOWNLOAD note (#671) 2017-09-05 11:14:58 -07:00
Paul Irish
3365562b2b Add DEBUG=* debugging guide to readme (#622) 2017-08-30 18:41:45 -04:00
Mohamed Oun
225e880d15 doc: Clarify that examples need Node v8 (#559)
The examples use async/await, but Node v6 doesn't support them, so to use these examples you either need Node 8 or a transpiler (like Babel) or to use promises.
2017-08-27 14:08:25 -07:00
Andrey Lushnikov
be4da580d4 Bump tip-of-tree version to 0.10.1-alpha (#534)
This patch:
- bumps tip-of-tree version to 0.10.1-alpha
- updates api.md to refer to released API and fix a nit in README.md
2017-08-24 22:47:57 -07:00
Vse Mozhet Byt
46115f9182 add missing backticks in README.md (#525) 2017-08-24 09:52:56 -07:00
Eric Bidelman
3b44de444f readme: add evaluate snippet (#524)
* readme: add evaluate snippet

pretty important method that we don't have a prominent example for.

* feedback

* Update README.md
2017-08-24 09:13:49 -07:00
Eric Bidelman
7e1f2f0609 readme: add console event debugging tip (#481) 2017-08-22 20:17:09 -07:00
AJ Jordan
e8b4288623 readme: fix missing word (#414) 2017-08-20 12:43:15 -07:00
Daniela Borges Matos de Carvalho
caa6f813a8 docs: note headless flag defaults to true (#332)
* Replace headless: false with headless: true

* fix: suggestions to improve docs
2017-08-20 12:40:29 -07:00
jakubsadura
628921950f README: Fix a typo (#385) 2017-08-18 16:49:58 -07:00
Brikou CARRE
8f43befcc9 Make prettier JS snippets (#377)
* Make prettier JS snippets

* Conform to CS (about curly brace)

* Apply feedback
2017-08-18 16:46:10 -07:00
Eric Bidelman
ae3fedfa91 readme: start of useful debugging tips (#352)
* readme: start of useful debugging tips

* feedback
2017-08-18 11:03:35 -07:00
Ken
500b956c84 #366 - tone of logo surface from light source (#369)
This is a minor cosmetic update on Puppeteer's logo. The rectangle surface at lower left corner seems to have the wrong shade, base on the scene's light source. Below are the original and the updated ones. Of course, if the designer intentionally wants to make the design asymmetric then this is irrelevant.
2017-08-18 10:21:37 -07:00
Divjot Singh
16e190b239 Indent the code in README.md (#319) 2017-08-17 19:54:51 -07:00
Paul Irish
a93377fc22 readme: migrate from travis-ci .com to .org (#297) 2017-08-16 12:51:41 -07:00
Ken
a06d2618bf readme: minor updates (#277)
- update links to puppeteer.launch() section of API
- minor fine-tuning of verbiage and small typo
2017-08-15 18:55:20 -07:00
Paul Irish
0a5f7258fd docs: add FAQ entry (#276) 2017-08-15 18:08:19 -07:00
Eric Bidelman
4c12d3a635 readme: npm badge (#273) 2017-08-15 17:37:55 -07:00
Andrey Lushnikov
1e5d9fd8c0 Proofreading documentation (#274)
This patch fixes documentation in a few places.
2017-08-15 17:33:03 -07:00
Paul Irish
1d2ae60e0d readme: new new temp logo (#267) 2017-08-15 11:49:26 -07:00
Andrey Lushnikov
cd54e5fb11 README: fix example 2017-08-15 10:12:55 -07:00
Eric Bidelman
5778b54924 readme: new temp logo (#265) 2017-08-15 10:08:32 -07:00
Eric Bidelman
124ca2b855 readme: bye bye sweet logo 2017-08-15 09:02:28 -07:00
JoelEinbinder
59256ee5ba Capitalize Chromium and Puppeteer (#263) 2017-08-15 00:14:12 -07:00
Andrey Lushnikov
13e8580a34 Use puppeteer.launch instead of browser constructor (#255)
This patch:
- split browser launching logic from Browser into `lib/Launcher.js`
- introduce `puppeteer` namespace which currently has a single `launch`
  method to start a browser

With this patch, the browser is no longer created with the `new
Browser(..)` command. Instead, it should be "launched" via the
`puppeteer.launch` method:

```js
const puppeteer = require('puppeteer');
puppeteer.launch().then(async browser => {
  ...
});
```

With this approach browser instance lifetime matches the lifetime of
actual browser process. This helps us:
- remove proxy streams, e.g. browser.stderr and browser.stdout
- cleanup browser class and make it possible to connect to remote
  browser
- introduce events on the browser instance, e.g. 'page' event. In case
  of lazy-launching browser, we should've launch browser when an event
  listener is added, which is unneded comlpexity.
2017-08-14 18:08:06 -07:00
Eric Bidelman
0a3dd4e727 readme: faq entries (#254)
* readme: faq entries

* Feedback
2017-08-14 17:55:40 -07:00
Andrey Lushnikov
5154d72342 Add separate README.md to phantom_shim (#252)
The PhantomShim specific readme should be a better explanation of
what phantom shim is and is not.
2017-08-14 10:13:48 -07:00
Andrey Lushnikov
7936be43f7 Update README.md
Remove typo in link description.
2017-08-10 18:36:02 -07:00
Eric Bidelman
1ee47d868b Doc polish. Example consistency (#233) 2017-08-10 18:31:54 -07:00
Andrey Lushnikov
e1d8a3781e Rename Page.navigate into Page.goto (#232)
Fixes #228.
2017-08-10 00:02:10 -07:00
Andrey Lushnikov
29adc5dc80 [examples] get rid of old examples
This patch:
- removes old phantom-js examples
- adds an example to load page without images

References #178
2017-08-08 00:44:15 -07:00
Andrey Lushnikov
6c163122bf Update default viewport size to be 800px by 600px (#194)
This patch updates default viewport size to be 800px by 600px.
This comes handy when observing scripts running in non-headless mode.
2017-08-02 15:47:00 -07:00
Andrey Lushnikov
97f80d243c [README] add features to the readme.md 2017-07-31 15:15:43 -07:00
Eric Bidelman
8e8517026f README: logo, add mention of headless in top blurb (#169) 2017-07-29 18:32:22 -07:00
Andrey Lushnikov
0f3a0dcbfc Update CONTRIBUTING.md and README.md
This patch:
- fixes wording in a few places
- fixes installation step on the README.md
2017-07-29 00:34:37 -07:00
Andrey Lushnikov
8d7d15fdb1 Update README.md
Make README.md examples consistent.
2017-07-27 19:23:21 -07:00
Andrey Lushnikov
7bfd56605b Update README.md
Make top links less ugly
2017-07-27 19:21:24 -07:00
Andrey Lushnikov
97c3e40ca2 Update README.md
Leave only essential information in the README.md

References #7
2017-07-27 19:15:30 -07:00
Andrey Lushnikov
cfc6a6ab38 Update CONTRIBUTING.md
Fixes #146.
2017-07-27 11:28:35 -07:00
dgozman
5ca92ffb71 Getting started run instructions 2017-07-18 11:13:29 -07:00