Skip to content

Improve post-release installation guidance - #14

Merged
HoungDev merged 1 commit into
mainfrom
agent/improve-pypi-readme
Aug 7, 2026
Merged

HoungDev merged 1 commit into
mainfrom
agent/improve-pypi-readme

Conversation

@HoungDev

@HoungDev HoungDev commented Aug 7, 2026

Copy link
Copy Markdown
Owner

What changed

  • Add a live PyPI version badge.
  • Make PyPI the primary installation path now that v0.1.0 is published.
  • Link users to the latest GitHub Release and its verified distribution hashes.
  • Replace README-relative images and links with canonical GitHub URLs so the content renders reliably outside the repository.

Why

The README still presented a source checkout as the default installation path after the first production release. Relative links also depend on GitHub repository context and are not portable when the README is used as package metadata.

Impact

New users get a one-command PyPI installation and clearer release provenance. The GitHub README improves immediately; PyPI metadata for 0.1.0 remains immutable, so the portable links will appear on the next package version.

Validation

  • ruff check .
  • ruff format --check .
  • pytest --basetemp .pytest-tmp/post-release-readme — 48 passed, 93.79% coverage
  • python -m build --no-isolation
  • twine check for wheel and sdist
  • all newly referenced URLs returned HTTP 200
  • git diff --check

@HoungDev
HoungDev marked this pull request as ready for review August 7, 2026 09:03
@HoungDev
HoungDev merged commit 8c0c1e9 into main Aug 7, 2026
7 checks passed
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