Skip to content

README: badges for PyPI, Python versions, CI, docs and license - #3

Merged
wrignj08 merged 1 commit into
mainfrom
docs/readme-badges
Nov 11, 2026
Merged

wrignj08 merged 1 commit into
mainfrom
docs/readme-badges

Conversation

@wrignj08

Copy link
Copy Markdown
Contributor

Adds a row of badges under the tagline:

  • PyPI version and supported Python versions, linking to PyPI
  • CI status on main, linking to Actions
  • the docs build for the stable version, linking to Read the Docs
  • the license

The row sits above the docs-start marker, so it shows on GitHub and PyPI but not on the docs site. The documentation link at the end of the status note is dropped, since the docs badge replaces it.

Every badge URL was checked to return a live image, and PyPI's renderer (readme_renderer) keeps all five. PyPI keeps each release's README, so the badges reach PyPI with the next release.

🤖 Generated with Claude Code

The badges sit above the docs-start marker, so they show on GitHub and PyPI but not on the docs site. The documentation link moves from the end of the status note to its badge.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@wrignj08
wrignj08 merged commit 2bb3425 into main Nov 11, 2026
9 checks passed
@wrignj08
wrignj08 deleted the docs/readme-badges branch November 11, 2026 04:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant