Skip to content

Commit e279c2e

Browse files
author
Jeremy Green
committedApr 14, 2015
updated readme
1 parent 0092127 commit e279c2e

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed
 

‎README.md

+26-5
Original file line numberDiff line numberDiff line change
@@ -53,31 +53,38 @@ With this in place, grunt-perfbudget will now test your site against the default
5353

5454
grunt-perfbudget takes the following options:
5555

56+
#### options.output
57+
58+
Type `String`
59+
Default value: NONE
60+
61+
The file to output the JSON results to.
62+
5663
#### options.url
5764

5865
Type `String`
59-
Default value: NONE
66+
Default value: NONE
6067

6168
The url you want to perform the tests on.
6269

6370
#### options.key
6471

6572
Type `String`
66-
Default value: NONE
73+
Default value: NONE
6774

6875
The API Key for the public instance of WPT. *Not needed if using a private instance of webpagetest*
6976

7077
#### options.location
7178

7279
Type `String`
73-
Default value: 'Dulles_Nexus5'
80+
Default value: 'Dulles_Nexus5'
7481

7582
The default WPT location/device to conduct the test using.
7683

7784
#### options.wptInstance
7885

7986
Type `String`
80-
Default value: 'www.webpagetest.org'
87+
Default value: 'www.webpagetest.org'
8188

8289
The WPT instance to conduct the tests with.
8390

@@ -133,7 +140,7 @@ The package loss rate (percentage of packets to drop). *Used when connectivity i
133140
#### options.repeatView
134141

135142
Type `Boolean`
136-
Default value: `false`
143+
Default value: `false`
137144

138145
If set to `true`, tests the budget against the repeat view. *By default, perfbudget tests the budget against the first view and doesn't ask WPT to run a test on the repeat view.*
139146

@@ -334,6 +341,20 @@ perfbudget: {
334341
}
335342
```
336343

344+
#### 5. Test http://google.com against default budget settings and output the results to a file.
345+
346+
```javascript
347+
perfbudget: {
348+
default: {
349+
options: {
350+
url: 'http://google.com',
351+
key: 'API_KEY_HERE',
352+
output: 'wpt-results.json'
353+
}
354+
}
355+
}
356+
```
357+
337358
## Contributing
338359
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
339360

0 commit comments

Comments
 (0)
Please sign in to comment.