[Pkg-javascript-commits] [node-tap-mocha-reporter] 04/137: doc

[Bastien Roucariès]

This is an automated email from the git hooks/post-receive script.

rouca pushed a commit to branch master
in repository node-tap-mocha-reporter.

commit 3c0730f20b885ebf5e32a684a15d2c4a9d6b46bc
Author: isaacs <i at izs.me>
Date:   Fri Apr 10 14:48:00 2015 -0700

    doc
---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..804fc6b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# tap-mocha-reporter
+
+Format a TAP stream using Mocha's set of reporters
+
+## USAGE
+
+On the command line, pipe TAP in, and it'll do its thing.
+
+```bash
+tap test/*.js | tap-mocha-reporter
+```
+
+You can also specify a reporter with the first argument.  The default
+is `spec`.
+
+```bash
+tap test/*.js | tap-mocha-reporter nyan
+```
+
+Programmatically, you can use this as a transform stream.
+
+```javascript
+var TSR = require('tap-mocha-reporter')
+
+fs.createReadStream('saved-test-output.tap')
+  .pipe(TSR('dot'))
+  .pipe(process.stdout)
+```

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-tap-mocha-reporter.git