From db8de11bb126699b58c14e44040c22ddd6d9dc52 Mon Sep 17 00:00:00 2001 From: Danilo Bargen Date: Mon, 15 Apr 2024 09:29:37 +0200 Subject: [PATCH] README: Add note about maintenance mode --- README.rst | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 4151311..5eb6458 100644 --- a/README.rst +++ b/README.rst @@ -1,26 +1,30 @@ Coverage.py Badge ================== -.. image:: https://github.com/dbrgn/coverage-badge/workflows/CI/badge.svg +.. |buildstatus| image:: https://github.com/dbrgn/coverage-badge/workflows/CI/badge.svg :alt: Build status :target: https://github.com/dbrgn/coverage-badge/actions?query=branch%3Amain - -.. image:: https://img.shields.io/pypi/dm/coverage-badge.svg +.. |downloads| image:: https://img.shields.io/pypi/dm/coverage-badge.svg :alt: PyPI Downloads :target: https://pypi.python.org/pypi/coverage-badge +.. |example| image:: https://cdn.rawgit.com/dbrgn/coverage-badge/main/example.svg + :alt: Example coverage badge -A small script to generate coverage badges using Coverage.py. Example of a generated badge: +|buildstatus| |downloads| -.. image:: https://cdn.rawgit.com/dbrgn/coverage-badge/main/example.svg - :alt: Example coverage badge + ⚠️ coverage-badge is in maintenance mode. I might still do occasional updates + and fixes from time to time, but there will be no added features. Most + people using coverage-badge might want to use genbadge_ instead, which has + more features (e.g. test badges, flake8 reports, etc). + +A small script to generate coverage badges using Coverage.py. + +Example of a generated badge: |example| The badge template has been taken from shields.io_, therefore it should look mostly good. (The spec is a bit stricter on the margins, but I can't easily do text width calculations in Python so the margins might not always be 4px.) -**:arrow_right: Note:** If you need a script with a few more features -(e.g. test badges, flake8 reports, etc), check out genbadge_. - .. _shields.io: http://shields.io/ .. _genbadge: https://smarie.github.io/python-genbadge/