diff --git a/README.md b/README.md index 4821369..9d29eeb 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ -# Python-Template +Python-Template +============================== A template repository for Python projects within the CCPBioSim organisation + +## Project Status + +| Category | Badges | +|----------------|--------| +| **Build** | [![CI](https://github.com/CCPBioSim/Python-Template/actions/workflows/example_package_project-ci.yaml/badge.svg)](https://github.com/CCPBioSim/Python-Template/actions/workflows/example_package_project-ci.yaml) | +| **Documentation** | [![Docs – Status](https://app.readthedocs.org/projects/ccpbiosim-python-template/badge/?version=latest)](https://ccpbiosim-python-template.readthedocs.io/en/latest/) | +| **PyPI** | [![PyPI - Version](https://img.shields.io/pypi/v/CCPBioSim-Python-Template.svg)](https://pypi.org/project/CCPBioSim-Python-Template/) [![PyPI - Status](https://img.shields.io/pypi/status/CCPBioSim-Python-Template.svg)](https://pypi.org/project/CCPBioSim-Python-Template/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/CCPBioSim-Python-Template.svg)](https://pypi.org/project/CCPBioSim-Python-Template/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/CCPBioSim-Python-Template.svg)](https://pypi.org/project/CCPBioSim-Python-Template/) | +| **Quality** | [![Coverage Status](https://coveralls.io/repos/github/CCPBioSim/Python-Template/badge.svg?branch=main)](https://coveralls.io/github/CCPBioSim/Python-Template?branch=main) |