From bdcf2f8c271d926f7801e8156207030ea8c92568 Mon Sep 17 00:00:00 2001
From: Dave Schaefer <dave.schaefer@gmail.com>
Date: Mon, 30 Dec 2019 21:13:02 -0700
Subject: [PATCH] docs - add badge instructions to quickstart guide

Show user how to add the Flake8 badge to their project.

These local URLs would need to be replaced
with a hosted https version
once the image is actually hosted somewhere.
---
 docs/source/index.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 9488985..6f5e8a5 100644
--- a/docs/source/index.rst
+++ b/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
 ================