README.md in wbench-0.2.3 vs README.md in wbench-0.3.0
- old
+ new
@@ -8,10 +8,16 @@
```bash
$ gem install wbench
```
+If you're running an older version (1.8) of ruby, you'll need the JSON gem.
+
+```bash
+$ gem install json
+```
+
You will need to install [Google Chrome](http://www.google.com/chrome) as well as the chromedriver utility.
You can install chromedriver (on OSX) with homebrew:
```bash
brew install chromedriver
@@ -37,10 +43,17 @@
```bash
wbench -b firefox https://www.desktoppr.co/
```
+### Setting the user agent
+You can also pass the `-u/--user-agent` option to change the browsers user agent (This can be useful for mobile testing).
+
+```bash
+wbench -u "Mozilla/5.0 (iPhone; U; ..." https://www.desktoppr.co/
+```
+
### Ruby API
You can programatically run the benchmarks. Simply specify the URL and
optionally the amount of runs.
@@ -70,7 +83,14 @@
"beacon-1.newrelic.com"=>[587, 235, 248],
"d1ros97qkrwjf5.cloudfront.net"=>[368, 14, 14],
"ssl.google-analytics.com"=>[497, 14, 14], "www.desktoppr.co"=>[191, 210, 203]}
```
-## TODO
-- Add ability to [gist](https://gist.github.com/) results
+### Gisting results
+
+You can install the [Github gist gem](https://github.com/defunkt/gist) and pipe in the results of wbench
+
+```
+gem install gist
+
+wbench http://www.google.com.au/ | gist -d "Google homepage"
+```