docs: refresh README for 0.56.0#653
Merged
Merged
Conversation
cofin
marked this pull request as ready for review
July 22, 2026 22:20
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Why
The README opening was difficult to scan and gave the project name and purpose too little visual weight. This refresh keeps the existing scope and voice while making database support, data tooling, and framework integrations easier to find.
Impact
This changes documentation only. The GitHub and PyPI README content remain aligned, and the package behavior is unchanged.
Checks
uv run python tools/pypi_readme.pyuvx prek run --files README.md docs/PYPI_README.mdgit diff --check