Doc: Enhance short description

2016-01-24 18:37:24 +01:00
parent a1eb9d7d2f
commit 376a6ed484
4 changed files with 12 additions and 2 deletions
--- a/README.rst
+++ b/README.rst
@@ -3,6 +3,9 @@ yamllint

 A linter for YAML files.

+yamllint does not only check for syntax validity, but for common cosmetic
+conventions such as lines length, trailing spaces, indentation, etc.
+
 .. image::
   https://travis-ci.org/adrienverge/yamllint.svg?branch=master
   :target: https://travis-ci.org/adrienverge/yamllint