From efadd32372901699f4372fb10dbebd16699ab8d5 Mon Sep 17 00:00:00 2001 From: Jan Wille Date: Sun, 10 Jul 2022 15:45:39 +0200 Subject: [PATCH] docs: add more badges existing bades are moved to the top and more badges are added. Additionaly, the bades are created using recplacement references which allows to move all meta informations to the bottom of the file. Badges provide quick and visual information about the projectstatus. They are created using https://shields.io --- README.rst | 38 ++++++++++++++++++++++++++------------ 1 file changed, 26 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index fe78142..5a6be0b 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,7 @@ +| |GitHub Badge| |PyPi version Badge| |Python version Badge| +| |CI status Badge| |Coverage Badge| |Docs Badge| + + yamllint ======== @@ -7,18 +11,6 @@ yamllint does not only check for syntax validity, but for weirdnesses like key repetition and cosmetic problems 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 - :alt: CI tests status -.. image:: - https://coveralls.io/repos/github/adrienverge/yamllint/badge.svg?branch=master - :target: https://coveralls.io/github/adrienverge/yamllint?branch=master - :alt: Code coverage status -.. image:: https://readthedocs.org/projects/yamllint/badge/?version=latest - :target: https://yamllint.readthedocs.io/en/latest/?badge=latest - :alt: Documentation status - Written in Python (compatible with Python 3 only). Documentation @@ -138,3 +130,25 @@ License ------- `GPL version 3 `_ + + + +.. |GitHub Badge| image:: https://badges.aleen42.com/src/github.svg + :target: https://github.com/adrienverge/yamllint + :alt: Github Repository +.. |PyPi version Badge| image:: https://img.shields.io/pypi/v/yamllint + :target: https://pypi.org/project/yamllint/ + :alt: PyPI package version +.. |Python version Badge| image:: https://img.shields.io/pypi/pyversions/yamllint + :target: https://pypi.org/project/yamllint/ + :alt: supported Python versions + +.. |CI status Badge| image:: https://travis-ci.org/adrienverge/yamllint.svg?branch=master + :target: https://travis-ci.org/adrienverge/yamllint + :alt: CI tests status +.. |Coverage Badge| image:: https://coveralls.io/repos/github/adrienverge/yamllint/badge.svg?branch=master + :target: https://coveralls.io/github/adrienverge/yamllint?branch=master + :alt: Code coverage status +.. |Docs Badge| image:: https://readthedocs.org/projects/yamllint/badge/?version=latest + :target: https://yamllint.readthedocs.io/en/latest/ + :alt: Documentation status