textlint-plugin-rst/README.md

reStructuredText support for textlint

# textlint-plugin-rst

reStructuredText(`*.rst`) support for [textlint](https://github.com/textlint/textlint "textlint").

## Installtion

To install textlint-plugin-rst, the follow python package must be installed.

 - [docutils-ast-writer](https://github.com/jimo1001/docutils-ast-writer "docutils-ast-writer")

And run follow command.

    npm install textlint-plugin-rst

## Usage

- Add `--plugin rst` to commoand options
- or
- Add following codes to `.textlintrc`
```
{
    "plugins": [
        "rst"
    ]
}
```

## License
MIT