Skip to content

Commit 484bdbb

Browse files
techousetechouse
committed
📝 update badge images in documentation for improved clarity and consistency
1 parent dbdd308 commit 484bdbb

2 files changed

Lines changed: 72 additions & 26 deletions

File tree

‎README.rst‎

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1028,47 +1028,70 @@ Special thanks to the authors of
10281028
Harband <https://github.com/ljharb>`__ - `TJ
10291029
Holowaychuk <https://github.com/visionmedia/node-querystring>`__
10301030

1031-
.. |PyPI - Version| image:: https://img.shields.io/pypi/v/qs_codec
1031+
.. |PyPI - Version| image:: https://img.shields.io/pypi/v/qs_codec?logo=pypi&label=PyPI
10321032
:target: https://pypi.org/project/qs-codec/
1033-
.. |PyPI - Downloads| image:: https://img.shields.io/pypi/dm/qs_codec
1033+
:alt: PyPI version
1034+
.. |PyPI - Downloads| image:: https://img.shields.io/pypi/dm/qs_codec?logo=pypi&label=PyPI%20downloads
10341035
:target: https://pypistats.org/packages/qs-codec
1035-
.. |PyPI - Status| image:: https://img.shields.io/pypi/status/qs_codec
1036-
.. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/qs_codec
1036+
:alt: PyPI downloads
1037+
.. |PyPI - Status| image:: https://img.shields.io/pypi/status/qs_codec?logo=pypi
1038+
:target: https://pypi.org/project/qs-codec/
1039+
:alt: PyPI status
1040+
.. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/qs_codec?logo=python&label=Python
1041+
:target: https://pypi.org/project/qs-codec/
1042+
:alt: Python version support
10371043
.. |PyPy Support| image:: https://img.shields.io/badge/PyPy-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-6f42c1?logo=pypy
10381044
:target: https://www.pypy.org/
10391045
:alt: PyPy support status
1040-
.. |PyPI - Format| image:: https://img.shields.io/pypi/format/qs_codec
1046+
.. |PyPI - Format| image:: https://img.shields.io/pypi/format/qs_codec?logo=python
1047+
:target: https://pypi.org/project/qs-codec/
1048+
:alt: PyPI format
10411049
.. |Test| image:: https://github.com/techouse/qs_codec/actions/workflows/test.yml/badge.svg
10421050
:target: https://github.com/techouse/qs_codec/actions/workflows/test.yml
1051+
:alt: Test Status
10431052
.. |CodeQL| image:: https://github.com/techouse/qs_codec/actions/workflows/github-code-scanning/codeql/badge.svg
10441053
:target: https://github.com/techouse/qs_codec/actions/workflows/github-code-scanning/codeql
1054+
:alt: CodeQL Status
10451055
.. |Publish| image:: https://github.com/techouse/qs_codec/actions/workflows/publish.yml/badge.svg
10461056
:target: https://github.com/techouse/qs_codec/actions/workflows/publish.yml
1057+
:alt: Publish Status
10471058
.. |Docs| image:: https://github.com/techouse/qs_codec/actions/workflows/docs.yml/badge.svg
10481059
:target: https://github.com/techouse/qs_codec/actions/workflows/docs.yml
1049-
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
1060+
:alt: Docs Status
1061+
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?logo=python
10501062
:target: https://github.com/psf/black
1063+
:alt: Code style Black
10511064
.. |codecov| image:: https://codecov.io/gh/techouse/qs_codec/graph/badge.svg?token=Vp0z05yj2l
10521065
:target: https://codecov.io/gh/techouse/qs_codec
1066+
:alt: Code Coverage
10531067
.. |Codacy| image:: https://app.codacy.com/project/badge/Grade/7ead208221ae4f6785631043064647e4
10541068
:target: https://app.codacy.com/gh/techouse/qs_codec/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
1069+
:alt: Codacy Quality
10551070
.. |License| image:: https://img.shields.io/github/license/techouse/qs_codec
10561071
:target: LICENSE
1057-
.. |GitHub Sponsors| image:: https://img.shields.io/github/sponsors/techouse
1072+
:alt: License
1073+
.. |GitHub Sponsors| image:: https://img.shields.io/github/sponsors/techouse?logo=github
10581074
:target: https://github.com/sponsors/techouse
1075+
:alt: GitHub Sponsors
10591076
.. |GitHub Repo stars| image:: https://img.shields.io/github/stars/techouse/qs_codec
10601077
:target: https://github.com/techouse/qs_codec/stargazers
1061-
.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
1078+
:alt: GitHub Repo stars
1079+
.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?logo=contributorcovenant
10621080
:target: CODE-OF-CONDUCT.md
1063-
.. |flake8| image:: https://img.shields.io/badge/flake8-checked-blueviolet.svg
1081+
:alt: Contributor Covenant
1082+
.. |flake8| image:: https://img.shields.io/badge/flake8-checked-blueviolet.svg?logo=python
10641083
:target: https://flake8.pycqa.org/en/latest/
1065-
.. |mypy| image:: https://img.shields.io/badge/mypy-checked-blue.svg
1084+
:alt: flake8 Status
1085+
.. |mypy| image:: https://img.shields.io/badge/mypy-checked-blue.svg?logo=python
10661086
:target: https://mypy.readthedocs.io/en/stable/
1067-
.. |pylint| image:: https://img.shields.io/badge/linting-pylint-yellowgreen.svg
1087+
:alt: typing mypy
1088+
.. |pylint| image:: https://img.shields.io/badge/linting-pylint-yellowgreen.svg?logo=python
10681089
:target: https://github.com/pylint-dev/pylint
1069-
.. |isort| image:: https://img.shields.io/badge/imports-isort-blue.svg
1090+
:alt: linting pylint
1091+
.. |isort| image:: https://img.shields.io/badge/imports-isort-blue.svg?logo=python
10701092
:target: https://pycqa.github.io/isort/
1071-
.. |bandit| image:: https://img.shields.io/badge/security-bandit-blue.svg
1093+
:alt: imports isort
1094+
.. |bandit| image:: https://img.shields.io/badge/security-bandit-blue.svg?logo=python
10721095
:target: https://github.com/PyCQA/bandit
10731096
:alt: Security Status
10741097
.. |pubdev| image:: https://img.shields.io/pub/v/qs_dart?logo=dart&label=pub.dev

‎docs/index.rst‎

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -93,47 +93,70 @@ Special thanks to the authors of
9393
Harband <https://github.com/ljharb>`__ - `TJ
9494
Holowaychuk <https://github.com/visionmedia/node-querystring>`__
9595

96-
.. |PyPI - Version| image:: https://img.shields.io/pypi/v/qs_codec
96+
.. |PyPI - Version| image:: https://img.shields.io/pypi/v/qs_codec?logo=pypi&label=PyPI
9797
:target: https://pypi.org/project/qs-codec/
98-
.. |PyPI - Downloads| image:: https://img.shields.io/pypi/dm/qs_codec
98+
:alt: PyPI version
99+
.. |PyPI - Downloads| image:: https://img.shields.io/pypi/dm/qs_codec?logo=pypi&label=PyPI%20downloads
99100
:target: https://pypistats.org/packages/qs-codec
100-
.. |PyPI - Status| image:: https://img.shields.io/pypi/status/qs_codec
101-
.. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/qs_codec
101+
:alt: PyPI downloads
102+
.. |PyPI - Status| image:: https://img.shields.io/pypi/status/qs_codec?logo=pypi
103+
:target: https://pypi.org/project/qs-codec/
104+
:alt: PyPI status
105+
.. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/qs_codec?logo=python&label=Python
106+
:target: https://pypi.org/project/qs-codec/
107+
:alt: Python version support
102108
.. |PyPy Support| image:: https://img.shields.io/badge/PyPy-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-6f42c1?logo=pypy
103109
:target: https://www.pypy.org/
104110
:alt: PyPy support status
105-
.. |PyPI - Format| image:: https://img.shields.io/pypi/format/qs_codec
111+
.. |PyPI - Format| image:: https://img.shields.io/pypi/format/qs_codec?logo=python
112+
:target: https://pypi.org/project/qs-codec/
113+
:alt: PyPI format
106114
.. |Test| image:: https://github.com/techouse/qs_codec/actions/workflows/test.yml/badge.svg
107115
:target: https://github.com/techouse/qs_codec/actions/workflows/test.yml
116+
:alt: Test Status
108117
.. |CodeQL| image:: https://github.com/techouse/qs_codec/actions/workflows/github-code-scanning/codeql/badge.svg
109118
:target: https://github.com/techouse/qs_codec/actions/workflows/github-code-scanning/codeql
119+
:alt: CodeQL Status
110120
.. |Publish| image:: https://github.com/techouse/qs_codec/actions/workflows/publish.yml/badge.svg
111121
:target: https://github.com/techouse/qs_codec/actions/workflows/publish.yml
122+
:alt: Publish Status
112123
.. |Docs| image:: https://github.com/techouse/qs_codec/actions/workflows/docs.yml/badge.svg
113124
:target: https://github.com/techouse/qs_codec/actions/workflows/docs.yml
114-
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
125+
:alt: Docs Status
126+
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?logo=python
115127
:target: https://github.com/psf/black
128+
:alt: Code style Black
116129
.. |codecov| image:: https://codecov.io/gh/techouse/qs_codec/graph/badge.svg?token=Vp0z05yj2l
117130
:target: https://codecov.io/gh/techouse/qs_codec
131+
:alt: Code Coverage
118132
.. |Codacy| image:: https://app.codacy.com/project/badge/Grade/7ead208221ae4f6785631043064647e4
119133
:target: https://app.codacy.com/gh/techouse/qs_codec/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
134+
:alt: Codacy Quality
120135
.. |License| image:: https://img.shields.io/github/license/techouse/qs_codec
121136
:target: LICENSE
122-
.. |GitHub Sponsors| image:: https://img.shields.io/github/sponsors/techouse
137+
:alt: License
138+
.. |GitHub Sponsors| image:: https://img.shields.io/github/sponsors/techouse?logo=github
123139
:target: https://github.com/sponsors/techouse
140+
:alt: GitHub Sponsors
124141
.. |GitHub Repo stars| image:: https://img.shields.io/github/stars/techouse/qs_codec
125142
:target: https://github.com/techouse/qs_codec/stargazers
126-
.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
143+
:alt: GitHub Repo stars
144+
.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?logo=contributorcovenant
127145
:target: CODE-OF-CONDUCT.md
128-
.. |flake8| image:: https://img.shields.io/badge/flake8-checked-blueviolet.svg
146+
:alt: Contributor Covenant
147+
.. |flake8| image:: https://img.shields.io/badge/flake8-checked-blueviolet.svg?logo=python
129148
:target: https://flake8.pycqa.org/en/latest/
130-
.. |mypy| image:: https://img.shields.io/badge/mypy-checked-blue.svg
149+
:alt: flake8 Status
150+
.. |mypy| image:: https://img.shields.io/badge/mypy-checked-blue.svg?logo=python
131151
:target: https://mypy.readthedocs.io/en/stable/
132-
.. |pylint| image:: https://img.shields.io/badge/linting-pylint-yellowgreen.svg
152+
:alt: typing mypy
153+
.. |pylint| image:: https://img.shields.io/badge/linting-pylint-yellowgreen.svg?logo=python
133154
:target: https://github.com/pylint-dev/pylint
134-
.. |isort| image:: https://img.shields.io/badge/imports-isort-blue.svg
155+
:alt: linting pylint
156+
.. |isort| image:: https://img.shields.io/badge/imports-isort-blue.svg?logo=python
135157
:target: https://pycqa.github.io/isort/
136-
.. |bandit| image:: https://img.shields.io/badge/security-bandit-blue.svg
158+
:alt: imports isort
159+
.. |bandit| image:: https://img.shields.io/badge/security-bandit-blue.svg?logo=python
137160
:target: https://github.com/PyCQA/bandit
138161
:alt: Security Status
139162
.. |pubdev| image:: https://img.shields.io/pub/v/qs_dart?logo=dart&label=pub.dev

0 commit comments

Comments
 (0)