Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme badges #178

Closed
veenstrajelmer opened this issue Jun 5, 2024 · 0 comments · Fixed by #193
Closed

update readme badges #178

veenstrajelmer opened this issue Jun 5, 2024 · 0 comments · Fixed by #193
Labels
chore Changes to the build process or auxiliary tools and libraries such as documentation generation

Comments

@veenstrajelmer
Copy link
Collaborator

veenstrajelmer commented Jun 5, 2024

What is the need for this task.
Since the code coverage is now computed by sonarcloud, it might be nice to communicate about this. And why not also adding the #downloads badge immediately.
Furthermore, the pypi badge in the readme is not the original link but "fury" that is lowres and updates only every once in a while. It should be

What is the task?
This is often done via a button in the README.md. This can be achieved by copying this markdown code:

[![PyPI version](https://img.shields.io/pypi/v/meshkernel.svg)](https://pypi.python.org/pypi/meshkernel)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Deltares_MeshKernelPy&metric=coverage)](https://sonarcloud.io/summary/overall?id=Deltares_MeshKernelPy)
[![Downloads](https://img.shields.io/pypi/dm/meshkernel.svg)](https://pypistats.org/packages/meshkernel)

It will look (and work) like this:
PyPI version
Coverage
Downloads

@veenstrajelmer veenstrajelmer added the chore Changes to the build process or auxiliary tools and libraries such as documentation generation label Jun 5, 2024
@veenstrajelmer veenstrajelmer changed the title add code coverage badge to readme update readme badges Oct 21, 2024
@veenstrajelmer veenstrajelmer linked a pull request Oct 21, 2024 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Changes to the build process or auxiliary tools and libraries such as documentation generation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant