hasufell/ale
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add more information to the README file.

Browse Source
This commit is contained in:
w0rp 2016-09-13 23:10:24 +01:00
parent d438da2b3b
commit 3de69db7e5
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -7,12 +7,24 @@ ALE makes use of NeoVim and Vim 8 job control functions and timers to
run linters on the contents of text buffers and return errors as run linters on the contents of text buffers and return errors as
text is changed in Vim. This allows for displaying warnings and text is changed in Vim. This allows for displaying warnings and
errors in files being edited in Vim before file has been saved errors in files being edited in Vim before file has been saved
back to disk. back to disk. In other words, this plugin allows you to lint while you type.
**NOTE:** This Vim plugin has been written pretty quickly so far, **NOTE:** This Vim plugin has been written pretty quickly so far,
and is still in rapid development. Documentation and stable APIs will and is still in rapid development. Documentation and stable APIs will
follow later. follow later.
## Supported Languages and Tools
| Language | Tools |
| -------- | ----- |
| Python | [flake8](http://flake8.pycqa.org/en/latest/) |
| JavaScript | [eslint](http://eslint.org/) |
If you would like to see support for more languages and tools, please
[create an issue](ale/issues) or [create a pull request](ale/pulls). If
your tool can read from stdin or you have code to suggest which is good,
support can be happily added for more tools.
## Known Bugs ## Known Bugs
(None at the moment) (None at the moment)