Skip to content

Commit

Permalink
Document required url parameter for generateScreenshots()
Browse files Browse the repository at this point in the history
Closes gh-54
  • Loading branch information
jazzzz authored and scottgonzalez committed Jul 25, 2017
1 parent 0037d3c commit 9aa2dda
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,7 @@ Gets the list of available browsers.
Creates a job to take screenshots.

* `options`: A hash of settings for the screenshots. See [screenshot job objects](#screenshot-job-objects) for details.
* `url`: The URL of the desired page.
* `browsers`: A collection of [browser objects](#browser-objects) indicating which browsers and devices to take screenshots with.
* `win_res` (optional): Only required if taking a screenshot on Windows. Defaults to `"1024x768"`.
* `mac_res` (optional): Only required if taking a screenshot on Mac OS X. Defaults to "1024x768"`.
Expand Down

0 comments on commit 9aa2dda

Please sign in to comment.