Skip to content

Commit dd4bb87

Browse files
authored
docs(README): Update usage (#32)
1 parent 492962d commit dd4bb87

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,32 @@ This rule check the spell by used with `prh.yml`.
2424
}
2525
```
2626

27-
`rulePaths` : path to YAML file.
27+
### Options
28+
29+
- `rulePaths`(required) : array of path to YAML file from `.textlintrc` file
30+
31+
```json
32+
{
33+
"rules": {
34+
"prh": {
35+
"rulePaths" :["./prh-rules/rule1.yml", "./prh-rules/rule2.yml"]
36+
}
37+
}
38+
}
39+
```
40+
41+
You can use `~` as Home directory abbreviation.
42+
43+
```json
44+
{
45+
"rules": {
46+
"prh": {
47+
"rulePaths" :["~/global-rule/rule1.yml"]
48+
}
49+
}
50+
}
51+
```
52+
2853

2954
### Fixable
3055

@@ -148,4 +173,4 @@ See [textlint-rule/prh-textlint-example: Example of textlint + prh.](https://git
148173

149174
## License
150175

151-
MIT
176+
MIT

0 commit comments

Comments
 (0)