Show a screenshot in the README
Merged
SV
19d ago+2+2+0123456789-0-0-0123456789
The README describes the app in words only. It now shows a screenshot of a real PR: the overview, and a diff chunk with its explanation beside it.
What changed
- A 1440 × 900 screenshot of astral-sh/uv#22916 (Add hints when
uv initfindspyproject.tomlwithout a project table), taken in the light theme with real explanations, is added underdocs/. - The README shows it below the introduction. The link is a full URL, so the image also shows on PyPI, which can't resolve relative paths, from the next release.
Test plan
- The image shows no placeholder or error text, and no personal data beyond the PR author's public GitHub name.
- The image link works once this merges to
main. Until then, the README preview on this branch shows a broken image.
Summary by cubic
Adds a screenshot to the README so readers see the app's diff explanations instead of only reading about them.
- The screenshot shows a real PR's overview and a diff chunk with its explanation.
- The image link uses a full URL so it also renders on PyPI after the next release.
- The image is broken in the README preview until this merges to
main.