Skip to content

Commit

Permalink
better lighthouse documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jaymoulin committed Nov 17, 2017
1 parent c4b3e72 commit 6616acb
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ Lighthouse
(default: /home/chrome/reports)
-w, --html Renders HTML reports alongside JSON reports
-l, --lighthouse_params Optional parameters to pass to lighthouse
(https://github.com/GoogleChrome/lighthouse/#cli-options)
(example: "--quiet --perf")
Puppeteer
Expand Down Expand Up @@ -119,7 +120,7 @@ For puppeteer, all params must be added in the `_unknown` entry and are prefixed

`verbose` is an array of true, the more `true` the more talkative the application.

Lighthouse params can be added respecting [their documentation](https://github.com/GoogleChrome/lighthouse/tree/master/docs)
Lighthouse params can be added respecting [their documentation](https://github.com/GoogleChrome/lighthouse/#cli-options)

### API

Expand Down
2 changes: 1 addition & 1 deletion bin/lighthouse-puppeteer.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ const optionDefinitions = [
name: 'lighthouse_params',
alias: 'l',
description: 'Optional parameters to pass to lighthouse' +
'\n(https://github.com/GoogleChrome/lighthouse/tree/master/docs)',
'\n(https://github.com/GoogleChrome/lighthouse/#cli-options)',
'\n([italic]{example}: "--quiet --perf")',
group: 'lighthouse'
},
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "google-lighthouse-puppeteer",
"version": "0.3.1",
"version": "0.3.2",
"description": "Google Lighthouse Puppeteer is a package to generate reports on multiple urls that allows or not authentication",
"main": "lighthouse-puppeteer.js",
"scripts": {
Expand Down

0 comments on commit 6616acb

Please sign in to comment.