Skip to content

README: centered header, badges, download button and demo - #5

Merged
noelcserepy merged 1 commit into
mainfrom
t3code/readme-hero
Oct 9, 2026
Merged

noelcserepy merged 1 commit into
mainfrom
t3code/readme-hero

Conversation

@noelcserepy

Copy link
Copy Markdown
Owner

Summary

The README header now follows the PhotoCraft layout: centered logo, title, bold tagline, badges, a download button, quick links, then the demo.

-# Annotate
-Take a screenshot, click to add notes, copy it. For macOS and Windows.
-<!-- TODO: demo GIF -->
+<div align="center">
+  logo (assets/annotate-logo.svg)
+  # Annotate
+  **tagline** + two short lines
+  badges: 100% Rust · macOS/Windows native · license MIT · latest release
+  [DOWNLOAD for macOS and Windows] -> releases/latest
+  Install · Keys · Report a bug
+  assets/demo.webp
+</div>
+## How it works
 1. Press Cmd+Shift+4 ...

The demo is the 34 MB screen-recording GIF as an 800px animated WebP at quality 60, 4.9 MB. A GIF at 640px and 12fps was still 19 MB.

Evidence

  • Before: plain # Annotate heading, one line of text, a TODO where the demo goes.
    After: rendered on GitHub at this branch in dark mode. The logo, badges, red download button and links are centered, and the demo animates below them.

Merge Danger

Door: two-way

Blast Radius: docs

Adds a 4.9 MB binary to history. Badges load from shields.io.

The demo is the screen recording as an 800px animated WebP, 4.9 MB instead of
the 34 MB GIF.
@noelcserepy

Copy link
Copy Markdown
Owner Author

Review: pass at 01f0fbf

Bugs

Summary

The PR adds a centered README header, badges, download links and an animated demo. No introduced bugs were found at head 01f0fbf.

Verified

  • GitHub HTML at the exact head renders the header and resolves the Install and Keys anchors.
  • HTTP probes: all five badges and both images return 200 through GitHub’s rendered URLs; download and issue links resolve.
  • Pillow probe: all 273 WebP frames decode successfully at 800×576, spanning 18.266 seconds. Inspected first, middle and final frames.
  • Temporary probes removed; worktree remains clean.

Not verified

  • Browser animation playback and visual layout across viewport sizes.
  • App execution and CI gates were intentionally skipped per review instructions; no application code or tests changed.

Standards

Items

None.

Spec

Merge danger

Door: two-way. Blast radius: docs. Only the README and demo asset change; reverting restores the previous presentation. The body agrees.

Items

None.

verdict: pass

@noelcserepy
noelcserepy merged commit 6c74aa5 into main Oct 9, 2026
3 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