Mirrors/yamllint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add more badges

Browse Source 
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
This commit is contained in:
Jan Wille
2022-07-10 15:45:39 +02:00
parent a09ad89268
commit efadd32372
1 changed files with 26 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.rst
View File

@@ -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 <LICENSE>`_
.. |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