Skip to content

README: prominent 'Watch the full demo' button under the preview#51

Open
nithiink wants to merge 1 commit into
mainfrom
readme-hero-demo-gif
Open

README: prominent 'Watch the full demo' button under the preview#51
nithiink wants to merge 1 commit into
mainfrom
readme-hero-demo-gif

Conversation

@nithiink

@nithiink nithiink commented Jul 6, 2026

Copy link
Copy Markdown
Owner

You looked at the GIF hero and didn't want it, so this reworks the PR in the new direction: keep the current YouTube thumbnail preview, and turn the plain text "Watch the demo" link under it into a real button that pulls clicks.

What changed

  • Kept the YouTube thumbnail preview exactly as it was on main (the clickable maxresdefault image → the video).
  • Swapped the plain ▶ Watch the demo text link beneath it for a proper button CTA: red, rounded, a play ▶ glyph, bold "Watch the full demo" — links to the same video.
  • Dropped the GIF and its asset entirely (no GIF, no mp4 — those still showed the home-network IP anyway).

The button

It's a self-hosted SVG committed in the repo at docs/demo/watch-demo-button.svg (no external services, no tracking). I pushed it and confirmed it renders on GitHub as a real image — you can see it live in the README on this branch, it's not a broken image.

Supporting line under the button

5.5 minutes, unedited: a spoken sentence becomes a real command, running hands-free.

One alternative if you'd rather lower the entry cost:

Core loop lands in the first 60 seconds; the full run is 5.5 minutes.

Why this should convert better than the old text link

A button reads as a clear thing to click, and the line right under it tells a skimming developer exactly what they'll get and how little time it costs — a plain underlined link does neither.

Files

  • README.md — the two hero lines (thumbnail kept; text link → button + caption).
  • docs/demo/watch-demo-button.svg — new button asset.

Yours to review and merge — nothing is merged.

…der the preview

Keep the YouTube thumbnail preview as-is; swap the plain text link
beneath it for a self-hosted SVG button (docs/demo/watch-demo-button.svg)
plus a one-line payoff caption. No GIF, no mp4.
@nithiink nithiink force-pushed the readme-hero-demo-gif branch from 9fbe227 to 09bfb28 Compare July 6, 2026 08:13
@nithiink nithiink changed the title README: inline autoplaying demo GIF as the hero README: prominent 'Watch the full demo' button under the preview Jul 6, 2026
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