Skip to content

Show a screenshot in the README - #22

Merged
svandragt merged 1 commit into
mainfrom
readme-screenshot
Nov 1, 2026
Merged

svandragt merged 1 commit into
mainfrom
readme-screenshot

Conversation

@svandragt

@svandragt svandragt commented Nov 1, 2026 •

Copy link
Copy Markdown
Owner

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

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.

Written for commit b2c9ee4. Summary will update on new commits.

View guided diff Turn on auto-fix

Co-Authored-By: Claude <noreply@anthropic.com>
@svandragt svandragt self-assigned this Nov 1, 2026

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 2 files

Tip: cubic could auto-approve low-risk PRs like this, if it thinks it's safe to merge. Learn more

View guided diff | Turn on auto-fix | Re-trigger cubic

@svandragt
svandragt merged commit ee416ce into main Nov 1, 2026
5 checks passed
@svandragt
svandragt deleted the readme-screenshot branch November 1, 2026 12:26
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