diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..e2cf9c6 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2017 abingham + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..377aff5 --- /dev/null +++ b/README.md @@ -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) +```