Skip to content

Give XCast a logo and a README that shows how it works - #12

Merged
agkloop merged 1 commit into
mainfrom
docs/readme-logo
Sep 20, 2026
Merged

agkloop merged 1 commit into
mainfrom
docs/readme-logo

Conversation

@agkloop

@agkloop agkloop commented Sep 20, 2026

Copy link
Copy Markdown
Owner

What

A logo. An X whose fourth arm is a Cast signal, on a tile shaped like a screen. One flat colour (the popup's accent), so it reads the same on light and dark and down to 16 px.

  • docs/img/logo.svg is the source. extension/icons/icon{16,32,48,128}.png are rendered from it with rsvg-convert; the README has the one-liner.
  • The extension had no icon at all. manifest.json now names the icons for the toolbar and the extensions page (this is a manifest change: icons and action.default_icon, nothing else).
  • The popup header shows the mark next to the name (<img src="icons/icon32.png">, allowed by img-src 'self').

A README rewritten around what a reader wants to know, in order: what it is, what it looks like, why not "Cast tab", features, how it works, install, use, troubleshooting, security, develop, known limits, uninstall.

  • Screenshots of the three popup states, light and dark, switched by the reader's colour scheme with <picture>. They are the real popup.html/css/js driven by a stubbed chrome API in headless Chrome, not mock-ups.
  • Four Mermaid diagrams: who talks to whom; one cast step by step; how direct or relay is chosen; what protects each hop. All four pass the Mermaid 11 parser and render.
  • Everything added since the last README: the remote, subtitle and audio pickers, the moving progress bar, the early connection to the TV, the helper version check, CI and fuzzing, plus troubleshooting rows for the new messages.
  • The "early software" warning, the known limits and the install steps keep their wording. Every relative link and image in the file exists.

Testing

  • Manifest parses; node --check on every script; node --test: 7 pass
  • Popup with the header logo rendered in light and dark (that is what the screenshots are); no CSP errors
  • Mermaid: 4 of 4 parse and render
  • How GitHub itself renders the page: look at the branch's README once, in light and dark
  • Reload the unpacked extension and see the icon in the toolbar

Adds 484 KB of images (six screenshots at 2x, four icons, one SVG).

🤖 Generated with Claude Code

The logo is an X whose fourth arm is a Cast signal, on a tile shaped like a
screen. One flat colour, the popup's accent, so it reads the same on light
and dark backgrounds and down to 16 pixels. docs/img/logo.svg is the
source; the extension's icons (16, 32, 48, 128) are rendered from it with
rsvg-convert, and the README says how. The extension had no icon at all:
the manifest now names them for the toolbar and the extensions page, and
the popup's header shows the mark next to the name.

The README is rewritten around what a reader wants to know, in order:
what it is, what it looks like, why not just "Cast tab", what it can do,
how it works, how to install and use it, what to do when it does not
work, how it is kept safe, how to work on it, what it cannot do. New in
it:

  - screenshots of the three popup states, light and dark, picked by the
    reader's colour scheme. They come from the real popup files driven by
    a stubbed chrome API, not from mock-ups
  - four Mermaid diagrams: who talks to whom, one cast step by step,
    how direct or relay is chosen, and what protects each hop. All four
    were run through the Mermaid parser
  - the features that were added since the last README: the remote, the
    subtitle and audio pickers, the moving progress bar, the early
    connection to the TV, the helper version check, CI and fuzzing
  - troubleshooting rows for the new messages

The "early software" warning, the known limits and the install steps keep
their wording; nothing is claimed that the docs do not back.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@agkloop
agkloop merged commit 0de4b1d into main Sep 20, 2026
3 checks passed
@agkloop agkloop mentioned this pull request Sep 20, 2026
1 task
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