Merge branch 'add-project-badge' into 'master'

Add project badge

See merge request pycqa/flake8!396

README.rst

@@ -2,6 +2,9 @@
  Flake8
 ========
 
+.. image:: docs/source/img/linter-flake8-green.svg
+    :target: https://gitlab.com/pycqa/flake8
+
 Flake8 is a wrapper around these tools:
 
 - PyFlakes

docs/source/img/linter-flake8-green.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="82" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="82" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h39v20H0z"/><path fill="#97ca00" d="M39 0h43v20H39z"/><path fill="url(#b)" d="M0 0h82v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"> <text x="205" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="290">linter</text><text x="205" y="140" transform="scale(.1)" textLength="290">linter</text><text x="595" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="330">flake8</text><text x="595" y="140" transform="scale(.1)" textLength="330">flake8</text></g> </svg>

docs/source/index.rst

@@ -69,6 +69,23 @@ Alternatively, if you want to *ignore* only one specific warning or error:
 Please read our user guide for more information about how to use and configure
 |Flake8|.
 
+Flake8 Project Badge
+--------------------
+If you'd like to add a |Flake8| badge to your project to show off your use of
+|Flake8|, add the following to your README.rst:
+
+::
+
+  .. image:: docs/source/img/linter-flake8-green.svg
+      :target: https://gitlab.com/pycqa/flake8
+
+or README.md:
+
+::
+
+  [![linter: flake8](docs/source/img/linter-flake8-green.svg)](https://gitlab.com/pycqa/flake8)
+
+
 FAQ and Glossary
 ================