docs: add badges (#275)

GenomicMedLab · Mar 21, 2024 · 79ed501 · 79ed501
1 parent 110feb2
commit 79ed501
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.github/workflows/checks.yml → .github/workflows/checks.yaml b/.github/workflows/checks.yml → .github/workflows/checks.yaml
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,6 +1,21 @@
 Cool-Seq-Tool |version|
 =======================
 
+.. image:: https://img.shields.io/pypi/v/cool-seq-tool.svg
+   :alt: PyPI version
+   :target: https://pypi.python.org/pypi/cool-seq-tool
+
+.. image:: https://img.shields.io/pypi/l/cool-seq-tool.svg
+   :alt: License
+   :target: https://github.com/genomicmedlab/cool-seq-tool/blob/main/LICENSE
+
+.. image:: https://img.shields.io/pypi/pyversions/cool-seq-tool?color=gr
+   :alt: PyPI - supported Python versions
+
+.. image:: https://github.com/genomicmedlab/cool-seq-tool/actions/workflows/checks.yaml/badge.svg
+   :alt: tests status
+   :target: https://github.com/genomicmedlab/cool-seq-tool/actions/workflows/checks.yaml
+
 The **CoolSeqTool** provides:
 
 * A Pythonic API on top of sequence data of interest to tertiary analysis tools, including mappings between gene names and transcripts, `MANE transcript <https://www.ncbi.nlm.nih.gov/refseq/MANE/>`_ descriptions, and the `Universal Transcript Archive <https://github.com/biocommons/uta>`_