readme: add notes on per runs #2410
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
[skip ci]
paulirish
force-pushed
the
paulirish-patch-1-1
branch
from
ae85658
to
42151b1
Compare
ebidel
suggested changes
May 31, 2017
| Lighthouse ships with a [performance-only config](https://github.com/GoogleChrome/lighthouse/blob/master/lighthouse-core/config/perf.json) that you can use: | ||
|
|
||
| ```js | ||
| const perfConfig: any = require('lighthouse/lighthouse-core/config/perf.json'); |
There was a problem hiding this comment.
launchChromeAndRunLighthouse to be consistent with the other example
const perfConfig = require('lighthouse/lighthouse-core/config/perf.json');`
// ...
launchChromeAndRunLighthouse(url, flags, perfConfig).then(results => {...});
docs/readme.md
Outdated
| @@ -28,6 +28,22 @@ launchChromeAndRunLighthouse('https://example.com', flags).then(results => { | |||
| }); | |||
| ``` | |||
|
|
|||
| ## Performance-only Lighthouse run | |||
docs/readme.md
Outdated
| lighthouse(url, flags, perfConfig) | ||
| ``` | ||
|
|
||
| You can also craft your own config (e.g. [plots.json](https://github.com/GoogleChrome/lighthouse/blob/master/lighthouse-core/config/plots.json)) for completely custom runs. |
There was a problem hiding this comment.
|
sg. done. |
paulirish
force-pushed
the
paulirish-patch-1-1
branch
from
05a59af
to
65aa057
Compare
ebidel
approved these changes
Jun 1, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.