Skip to content

Add a README header with the Whisper Code logo - #10

Merged
dimastatz merged 1 commit into
mainfrom
docs/readme-header
Oct 10, 2026
Merged

dimastatz merged 1 commit into
mainfrom
docs/readme-header

Conversation

@dimastatz

Copy link
Copy Markdown
Owner

Adds an HTML header to the README, matching whisper-flow's:

  • a centered title, Whisper Code, and the subtitle "Real-Time Voice Dictation for VS Code, Powered by Whisper Flow"
  • badges for CI status, latest release, VS Code 1.95+, and MIT license
  • a new logo, docs/images/whisper-code.png, shown at 256 px inside <kbd> like whisper-flow's

The logo is whisper-flow's surfer, from the same commit its README links (da8b67c), with the VS Code app icon in the top-right corner to show this is the VS Code extension. The icon is unmodified apart from scaling; it came from the installed VS Code app (Code.icns). The image is 512×512 (409 KB), so it stays sharp on high-DPI screens at 256 px.

Compared with whisper-flow's header, this one uses valid <br> (whisper-flow has </br>) and gives every image alt text.

Checked: prettier --check passes. vsce package succeeds: the badge sources are on vsce's trusted list, and the logo is rewritten to https://github.com/dimastatz/whisper-code/raw/HEAD/docs/images/whisper-code.png, so it also shows on the Marketplace page. The image isn't bundled in the VSIX (docs/** is excluded).

Trademark: the VS Code icon is a Microsoft trademark. Microsoft's guidelines generally allow it, unaltered, to show that something works with VS Code, which is how it's used here. Worth a look before publishing to the Marketplace.

🤖 Generated with Claude Code

https://claude.ai/code/session_01NcUyc2475ugBRGPm7yQMzy

The header mirrors whisper-flow's: a centered title, subtitle, badges and
logo. The logo is whisper-flow's surfer with the VS Code icon in the
top-right corner, at 512 px (shown at 256).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NcUyc2475ugBRGPm7yQMzy
@dimastatz
dimastatz merged commit 2f9d096 into main Oct 10, 2026
5 checks passed
@dimastatz dimastatz mentioned this pull request Oct 10, 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