Browse Source

update README w/ playground link, fix mocha link

Kyle P Davis 10 years ago
parent
commit
44875e315b
1 changed files with 20 additions and 17 deletions
  1. 20 17
      README.md

+ 20 - 17
README.md

@@ -1,31 +1,33 @@
 benchmarksman
 =============
-
 A handy wrapper around [benchmark.js][benchmark] to make writing
-benchmarks as easy as writing test cases (using the
-[mocha][mocha] exports UI).
+benchmarks as easy as writing test cases (in [mocha][mocha] via the exports UI).
 
 
 
-Why
-===
+## Why
 
 Using [benchmark.js][benchmark] directly can be a little tedious if you just
-want it to log ops/sec for a bunch of different code snippets.
+want it to get the ops/sec for a bunch of different code snippets.
+
+
+
+## Usage
 
+Below are some of the ways to use `benchmarksman` in your project.
 
+If instant gratification is your thing, then get your fix with a live demo
+and run some quick benchmarks on the [playground site][gh-pages].
 
-Usage
-=====
 
-Command Line
-------------
-```bash
+
+### Command Line
+```console
 benchmarksman bench/array.js
 ```
 
-Programmatic
-------------
+
+### Programmatic
 ```javascript
 exports.Date = {
 	"#getTime()": function(){
@@ -38,8 +40,8 @@ exports.Date = {
 if (!module.main) require("benchmarksman").runner(exports);
 ```
 
-Output
-------
+
+### Output
 ```console
 Date #getTime() x 7,705,532 ops/sec ±2.95% (94 runs sampled)
 Date .now() x 15,132,312 ops/sec ±1.85% (94 runs sampled)
@@ -49,5 +51,6 @@ Date .now() x 15,132,312 ops/sec ±1.85% (94 runs sampled)
 
 
 
-[benchmark]: http://benchmarkjs.com
-[mocha]: http://visionmedia.github.io/mocha/
+[benchmark]: http://benchmarkjs.com/
+[mocha]: http://mochajs.org/
+[gh-pages]: https://riveragroup.github.io/benchmarksman/