Doc: Add a screenshot

2016-01-23 14:30:24 +01:00
parent 387d14f816
commit fee72d484e
4 changed files with 21 additions and 6 deletions
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,6 +3,20 @@ yamllint documentation

 A linter for YAML files.

+Screenshot
+----------
+
+.. image:: screenshot.png
+   :alt: yamllint screenshot
+
+.. note::
+
+   The default output format is inspired by `eslint <http://eslint.org/>`_, a
+   great linting tool for Javascript.
+
+Table of contents
+-----------------
+
 .. toctree::
   :maxdepth: 2