Skip to content

Commit 4164677

Browse files
committed
docs(readme): add options config
1 parent ac59cf7 commit 4164677

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# textlint-rule-max-ten [![Build Status](https://travis-ci.org/azu/textlint-rule-max-ten.svg?branch=master)](https://travis-ci.org/azu/textlint-rule-max-ten)
22

3-
[textlint](https://github.com/azu/textlint "textlint") rule is that limit maxinum ten(、) count of sentence.
3+
[textlint](https://github.com/azu/textlint "textlint") rule is that limit maximum ten(、) count of sentence.
44

55
## Installation
66

@@ -12,6 +12,22 @@
1212
$ textlint --rule max-ten README.md
1313
# 11:0 error 一つの文で"、"を3つ以上使用しています max-ten
1414

15+
## Configure
16+
17+
Configure the maximum number of "、" allowed in a sentence. The default is `3`
18+
19+
Configure `"max"` value of the `.textlintrc` file.
20+
21+
```json
22+
{
23+
"rules": {
24+
"max-ten": {
25+
"max" : 3
26+
}
27+
}
28+
}
29+
```
30+
1531
## Tests
1632

1733
npm test

0 commit comments

Comments
 (0)