adding PyPI badge and installation command

marschall-lab · Jul 29, 2024 · c84f1b9 · c84f1b9
1 parent 0c1ef0f
commit c84f1b9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/README.rst b/docs/README.rst
@@ -1,3 +1,6 @@
+.. image:: https://img.shields.io/pypi/v/gaftools.svg?branch=main
+    :target: https://pypi.python.org/pypi/gaftools
+
 .. image:: https://github.com/marschall-lab/gaftools/workflows/CI/badge.svg
 
 

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -46,7 +46,9 @@ To remove :code:`gaftools`, the conda environment needs to be removed using::
 Installing from PyPI
 --------------------
 
-[gaftools has not been uploaded to PyPI. Documentation will be updated when uploaded]
+:code:`gaftools` is now available on PyPI and can be installed with::
+
+    pip install gaftools
 
 
 Installing from Conda