Skip to content

Commit 930d857

Browse files
committed
enhance readme
1 parent 9330766 commit 930d857

File tree

2 files changed

+49
-9
lines changed

2 files changed

+49
-9
lines changed

README.md

+44-7
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,32 @@
1+
<!--@'# ' + package.name-->
12
# tap-diff
3+
<!--/@-->
24

3-
[![npm version](https://badge.fury.io/js/tap-diff.svg)](http://badge.fury.io/js/tap-diff)
5+
<!--@shields.flatSquare('npm')-->
6+
[![NPM version](https://img.shields.io/npm/v/tap-diff.svg?style=flat-square)](https://www.npmjs.com/package/tap-diff)
7+
<!--/@-->
48

59
The most human-friendly [TAP reporter](https://github.com/substack/tape#pretty-reporters).
610

711
![Screenshot](screenshot1.png)
812

913
![Screenshot](screenshot2.png)
1014

11-
## How to use
15+
<!--@installation()-->
16+
## Installation
1217

13-
You can use tap-notify in the same way as other [TAP reporters](https://github.com/substack/tape#pretty-reporters).
18+
This module is installed via npm:
1419

20+
```sh
21+
npm install tap-diff --global
1522
```
16-
npm install -g tap-diff
17-
```
23+
<!--/@-->
1824

19-
```
25+
## How to use
26+
27+
You can use tap-notify in the same way as other [TAP reporters](https://github.com/substack/tape#pretty-reporters).
28+
29+
```sh
2030
tape ./*.test.js | tap-diff
2131
```
2232

@@ -43,6 +53,33 @@ test('timing test', (t) => {
4353
})
4454
```
4555

56+
<!--@license()-->
4657
## License
4758

48-
MIT
59+
[MIT](./LICENSE) © [axross](http://axross.me/)
60+
<!--/@-->
61+
62+
* * *
63+
64+
<!--@dependencies({ shield: 'flat-square' })-->
65+
## <a name="dependencies">Dependencies</a> [![Dependency status for master](https://img.shields.io/david/axross/tap-diff/master.svg?style=flat-square)](https://david-dm.org/axross/tap-diff/master)
66+
67+
- [chalk](https://github.com/chalk/chalk): Terminal string styling done right. Much color.
68+
- [diff](https://github.com/kpdecker/jsdiff): A javascript text diff implementation.
69+
- [duplexer](https://github.com/Raynos/duplexer): Creates a duplex stream
70+
- [figures](https://github.com/sindresorhus/figures): Unicode symbols with Windows CMD fallbacks
71+
- [jsondiffpatch](https://github.com/benjamine/jsondiffpatch): Diff & Patch for Javascript objects
72+
- [pdiff](https://github.com/HiroakiMikami/pdiff): A better diffing tool
73+
- [pretty-ms](https://github.com/sindresorhus/pretty-ms): Convert milliseconds to a human readable string: 1337000000 → 15d 11h 23m 20s
74+
- [tap-parser](https://github.com/substack/tap-parser): parse the test anything protocol
75+
- [through2](https://github.com/rvagg/through2): A tiny wrapper around Node streams2 Transform to avoid explicit subclassing noise
76+
77+
<!--/@-->
78+
79+
<!--@devDependencies({ shield: 'flat-square' })-->
80+
## <a name="dev-dependencies">Dev Dependencies</a> [![devDependency status for master](https://img.shields.io/david/dev/axross/tap-diff/master.svg?style=flat-square)](https://david-dm.org/axross/tap-diff/master#info=devDependencies)
81+
82+
- [babel](https://github.com/babel/babel): Turn ES6 code into readable vanilla ES5 with source maps
83+
- [mos](https://github.com/zkochan/mos): A pluggable module that injects content into your markdown files via hidden JavaScript snippets
84+
85+
<!--/@-->

package.json

+5-2
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
"version": "0.1.1",
44
"description": "The most human-friendly TAP reporter",
55
"main": "./distributions/index.js",
6+
"preferGlobal": true,
67
"bin": {
78
"tap-diff": "./distributions/cli.js"
89
},
910
"scripts": {
1011
"babel": "babel ./sources --out-dir ./distributions",
11-
"test": "echo \"Error: no test specified\" && exit 1"
12+
"test": "mos test",
13+
"md": "mos"
1214
},
1315
"author": "axross <[email protected]> (http://axross.me/)",
1416
"license": "MIT",
@@ -24,7 +26,8 @@
2426
"through2": "^2.0.0"
2527
},
2628
"devDependencies": {
27-
"babel": "^5.8.34"
29+
"babel": "^5.8.34",
30+
"mos": "^0.15.0"
2831
},
2932
"repository": {
3033
"type": "git",

0 commit comments

Comments
 (0)