Skip to content

Commit 3c06a72

Browse files
authored
Enhance README with project status and badges
Added project status section with badges for build, documentation, PyPI, and quality.
1 parent b78fe06 commit 3c06a72

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,12 @@
1-
# Python-Template
1+
Python-Template
2+
==============================
23
A template repository for Python projects within the CCPBioSim organisation
4+
5+
## Project Status
6+
7+
| Category | Badges |
8+
|----------------|--------|
9+
| **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) |
10+
| **Documentation** | [![Docs – Status](https://app.readthedocs.org/projects/ccpbiosim-python-template/badge/?version=latest)](https://ccpbiosim-python-template.readthedocs.io/en/latest/) |
11+
| **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/) |
12+
| **Quality** | [![Coverage Status](https://coveralls.io/repos/github/CCPBioSim/Python-Template/badge.svg?branch=main)](https://coveralls.io/github/CCPBioSim/Python-Template?branch=main) |

0 commit comments

Comments
 (0)