Closed JimMadge closed 2 months ago
Is there any other README tidying up we'd like to do in this PR?
This PR does not seem to contain any modification to coverable code.
Can we add a PyPI link and download badge in this PR?
Also - if we want to have a different README for PyPI than for GitHub, we can easily do that. Thoughts @JimMadge @craddm ?
Also - if we want to have a different README for PyPI than for GitHub, we can easily do that. Thoughts @JimMadge @craddm ?
I'd rather have one if possible. I would guess otherwise we risk the two documents getting out of sync.
@jemrobinson Do you like the badge with the PyPI version?
We could also do something like
Maybe add the "number of downloads" badge too? Also we could separate/re-order the badges onto different lines, grouping by type e.g. facts (version number, licence, number of contributors), variable statuses (test results, PyPI downloads), ways to contribute (e.g. Slack, email?).
:white_check_mark: Checklist
Enable foobar integration
rather than515 foobar
).develop
.:vertical_traffic_light: Depends on
:arrow_heading_up: Summary
Use emoji characters as the GitHub keys do not render in other places where the README is sourced (e.g. PyPI).
:closed_umbrella: Related issues
:microscope: Tests