@azu/textlint-config-readme

Sharable Configuration for textlint.

This config set aim to lint README file.

"textlint-rule-alex": "^1.0.1",
"textlint-rule-common-misspellings": "^1.0.1",
"textlint-rule-no-dead-link": "^0.2.0",
"textlint-rule-no-todo": "^2.0.0",
"textlint-rule-rousseau": "^1.4.1",
"textlint-rule-write-good": "^0.1.4"

Installation

npm install -D @azu/textlint-config-readme textlint

Usage

$(npm bin)/textlint --config @azu/textlint-config-readme README.md

Tests

npm test

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

License

MIT