From 900b2e7ea7efb2f8584363d970f2faabf5ca5414 Mon Sep 17 00:00:00 2001 From: Shuvalov Anton Date: Sun, 12 Apr 2015 17:59:03 +0300 Subject: [PATCH] add example --- test/bench.js | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/test/bench.js b/test/bench.js index 0fd5185..a510478 100755 --- a/test/bench.js +++ b/test/bench.js @@ -7,6 +7,20 @@ var textr = require('../'); var program = require('commander'); var pkg = require('../package'); +/** + * Simple benchmark which can be used as CLI in the future. + * + * @example + * + * $ echo 'hello "world"' > test + * $ cat test | bench.js -t typographic-single-spaces,typographic-quotes + * + * hello "world" + * 1654434 cycles per second% + * + * + * + */ program .version(pkg.version) .option('-c, --cycles', 'create new tf on every cycle')