Skip to content

Commit 53e394e

Browse files
committed
Add the version badge and enhance some wordings
1 parent bd45787 commit 53e394e

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

ReadMe.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# textlint-rule-write-good
22

3+
[![npm](https://img.shields.io/npm/v/textlint-rule-write-good.svg)](https://www.npmjs.com/package/textlint-rule-write-good)
34
[![Build Status](https://travis-ci.org/nodaguti/textlint-rule-write-good.svg?branch=master)](https://travis-ci.org/nodaguti/textlint-rule-write-good)
45
[![Dependency Status](https://david-dm.org/nodaguti/textlint-rule-write-good.svg)](https://david-dm.org/nodaguti/textlint-rule-write-good)
56
[![devDependency Status](https://david-dm.org/nodaguti/textlint-rule-write-good/dev-status.svg)](https://david-dm.org/nodaguti/textlint-rule-write-good#info=devDependencies)
67

78
[textlint](https://github.com/textlint/textlint) rule
8-
to check your English styles with [btford/write-good](https://github.com/btford/write-good).
9+
to check your English writing styles with [btford/write-good](https://github.com/btford/write-good).
910

1011
## Installation
1112

@@ -22,7 +23,9 @@ $ textlint --rule textlint-rule-write-good some-text-to-proofread.txt
2223

2324
## Options
2425

25-
You can disable each types of checks via `.textlintrc`.
26+
All checks except for [`eprime`](https://github.com/btford/write-good#eprime) are enabled by default.
27+
28+
You can disable each type of checks by passing `false` in `.textlintrc`.
2629

2730
```
2831
{
@@ -35,7 +38,7 @@ You can disable each types of checks via `.textlintrc`.
3538
}
3639
```
3740

38-
For available check types, see [btford/write-good#checks](https://github.com/btford/write-good#checks)
41+
For available checks, please refer to [btford/write-good#checks](https://github.com/btford/write-good#checks).
3942

4043
## Tests
4144

0 commit comments

Comments
 (0)