summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2016-09-13 23:10:24 +0100
committerw0rp <devw0rp@gmail.com>2016-09-13 23:10:24 +0100
commit3de69db7e5952af1be808bbbc21b9937073b9253 (patch)
tree832aefea914e09298e412ce638f10d57ff6cb8fa /README.md
parentd438da2b3b166ca4113fc7cbd3424311357fb3f3 (diff)
downloadale-3de69db7e5952af1be808bbbc21b9937073b9253.zip
Add more information to the README file.
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0104771b..188a8e77 100644
--- a/README.md
+++ b/README.md
@@ -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
text is changed in Vim. This allows for displaying warnings and
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,
and is still in rapid development. Documentation and stable APIs will
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
(None at the moment)