diff --git a/README.rst b/README.rst index a182b9b..5383558 100644 --- a/README.rst +++ b/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 diff --git a/docs/source/img/linter-flake8-green.svg b/docs/source/img/linter-flake8-green.svg new file mode 100644 index 0000000..dfd70b9 --- /dev/null +++ b/docs/source/img/linter-flake8-green.svg @@ -0,0 +1 @@ + linterlinterflake8flake8 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 ================