Skip to content

Commit

Permalink
Close #42 PR: Update help command and README to be more accurate.
Browse files Browse the repository at this point in the history
  • Loading branch information
dcorb authored and sindresorhus committed Jan 12, 2015
1 parent d0b69bc commit fc0670c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,18 +108,17 @@ $ npm install --global psi
$ psi --help
Usage
a11y <url>
psi <url> <options>
Example
a11y todomvc.com
psi todomvc.com --strategy=mobile
Options
--key Google API Key. By default the free tier is used.
--strategy Strategy to use when analyzing the page: mobile|desktop
--format Output format: cli|json|tap
--locale Locale results should be generated in.
--threshold Threshold score to pass the PageSpeed test.
--prettyprint Pretty print the result.
```


Expand All @@ -135,4 +134,4 @@ For testing local project, we recommend using [ngrok](http://www.jamescryer.com/
## License

Apache-2.0
Copyright 2014 Google Inc
Copyright 2015 Google Inc
7 changes: 3 additions & 4 deletions cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,17 @@ var psi = require('./');
var cli = meow({
help: [
'Usage',
' a11y <url>',
' psi <url> <options>',
'',
'Example',
' a11y todomvc.com',
' psi todomvc.com --strategy=mobile',
'',
'Options',
' --key Google API Key. By default the free tier is used.',
' --strategy Strategy to use when analyzing the page: mobile|desktop',
' --format Output format: cli|json|tap',
' --locale Locale results should be generated in.',
' --threshold Threshold score to pass the PageSpeed test.',
' --prettyprint Pretty print the result.'
' --threshold Threshold score to pass the PageSpeed test.'
].join('\n')
});

Expand Down

0 comments on commit fc0670c

Please sign in to comment.