README as a product page; install moves to INSTALL.md - #17
Merged
Merged
Conversation
The README now sells SpeakUp to people who talk to agents: hero figure, why, agents, the M1 speed table, privacy, a FAQ in plain questions for search, and a three-line install. Everything operational (requirements, first launch, updating, uninstalling, signing, CLI, troubleshooting) is in INSTALL.md. The pictures are rendered from the app's own views by a new `--screenshots <dir>` launch flag, which shows the real overlay pill on a stand-in desktop in light and dark and quits without starting the hotkey, microphone or engine. scripts/make-screenshots.sh wraps it and also produces the social preview card. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
dinooo13
force-pushed
the
readme-product-page
branch
from
September 12, 2026 01:29
a6f2272 to
6635739
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites the README as a product page aimed at people who dictate prompts to Claude Code, Codex, Cursor and OpenCode, and moves everything operational to a new INSTALL.md.
<picture>. An HTML comment marks where the hero GIF goes once recorded.SpeakUp --screenshots <dir>renders the real overlay pill on a stand-in desktop and quits. It never starts the hotkey, microphone or engine, so it can run beside a copy in use.scripts/make-screenshots.shwraps it.Not on the critical path; no benchmark needed. Repo description and topics were updated separately.
Test plan
swift buildandswift test(59 tests) passscripts/make-screenshots.shrenders all five imagesdocs/images/social-preview.pngunder Settings → Social preview🤖 Generated with Claude Code