Skip to content

Commit 6357bc0

Browse files
committed
enhance readme
1 parent bd42237 commit 6357bc0

File tree

2 files changed

+25
-14
lines changed

2 files changed

+25
-14
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,33 @@
11
# tap-diff
22

3-
[![npm version](https://badge.fury.io/js/tap-diff.svg)](http://badge.fury.io/js/tap-diff)
3+
> The most human-friendly TAP reporter
44
5-
The most human-friendly [TAP reporter](https://github.com/substack/tape#pretty-reporters).
5+
<!--@shields('npm')-->
6+
[![npm version](https://img.shields.io/npm/v/tap-diff.svg)](https://www.npmjs.com/package/tap-diff)
7+
<!--/@-->
68

79
![Screenshot](screenshot1.png)
810

911
![Screenshot](screenshot2.png)
1012

13+
## Installation
14+
15+
```sh
16+
npm install --global tap-diff
17+
```
18+
1119
## How to use
1220

1321
You can use tap-diff in the same way as other [TAP reporters](https://github.com/substack/tape#pretty-reporters).
1422

15-
```
16-
npm install -g tap-diff
17-
```
18-
19-
```
23+
```sh
2024
tape ./*.test.js | tap-diff
2125
```
2226

2327
tap-diff uses [chalk](https://www.npmjs.com/package/chalk) for adding color, which automatically detects
2428
color terminals. If you're piping the output and want to force color:
2529

26-
```
27-
FORCE_COLOR=t tape ./*.test.js | tap-diff
28-
```
30+
FORCE_COLOR=t tape ./*.test.js | tap-diff
2931

3032
Or use with `createStream()`:
3133

@@ -52,4 +54,4 @@ test('timing test', (t) => {
5254

5355
## License
5456

55-
MIT
57+
[MIT](./LICENSE) © [axross](http://axross.me/)

package.json

Lines changed: 12 additions & 3 deletions
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 <kou@axross.org> (http://axross.me/)",
1416
"license": "MIT",
@@ -24,7 +26,9 @@
2426
"through2": "^2.0.0"
2527
},
2628
"devDependencies": {
27-
"babel": "^5.8.34"
29+
"babel": "^5.8.34",
30+
"mos": "^1.3.1",
31+
"mos-plugin-readme": "^1.0.4"
2832
},
2933
"repository": {
3034
"type": "git",
@@ -41,5 +45,10 @@
4145
"test",
4246
"reporter",
4347
"diff"
44-
]
48+
],
49+
"mos": {
50+
"plugins": [
51+
"readme"
52+
]
53+
}
4554
}

0 commit comments

Comments
 (0)