Added README and LICENSE.

This commit is contained in:
Austin Bingham
2017-05-14 16:14:11 +02:00
parent ccb6d68d14
commit 134dac45dd
2 changed files with 38 additions and 0 deletions

17
README.md Normal file
View File

@@ -0,0 +1,17 @@
# flycheck-vale
This package provides [flycheck](http://www.flycheck.org/) integration
for [vale](https://github.com/ValeLint/vale). Flycheck is an Emacs system for
on-the-fly syntax checking. Vale is a natural language linter. So with
`flycheck-vale` you get on-the-fly natural language linting.
Right now `flycheck-vale` is very new and unpolished. Ideas, PRs, etc. are welcome!
## Quickstart
To use `flycheck-vale` just `require` it and run `flycheck-vale-setup`:
```emacs-lisp
(require 'flycheck-vale)
(flycheck-vale-setup)
```