Skip to content

Docs: hero GIF and a shorter README - #67

Merged
dinooo13 merged 4 commits into
mainfrom
docs/readme-hero
Sep 28, 2026
Merged

dinooo13 merged 4 commits into
mainfrom
docs/readme-hero

Conversation

@dinooo13

@dinooo13 dinooo13 commented Sep 28, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Hero GIF (docs/images/hero.gif, 948 KB, 1200 px, 11 s). A dictation into Claude Code in this repository, using the Live style: hold Option+Space and the pill streams the words, tap V, let go, and the prompt is pasted and sent while Claude starts reading DictationCoordinator. A toast at the top names the keys as they are pressed, so the default hold and send keys can be learned from the GIF. The send key is V, the default from Hotkey: V is the default send key #68, so merge that first.
  • Shorter README (174 → 110 lines). Speed, privacy, the send key and the agents were each made three or four times. Now there is a short pitch and three sections (speed, privacy, agents). Install moves up and says plainly that Pladder builds from source. The remaining features get one line each, and the FAQ keeps five questions the rest of the page doesn't already answer.
  • New docs/USAGE.md for the detail: keys (push to talk, send, toggle, Escape, without Accessibility), dictionary, learned corrections, fillers, spoken punctuation, polish, the pill's styles (the styles picture moves here), mute, languages, long dictations, the CLI.
  • New docs/PRIVACY.md with the full privacy section. It no longer claims five thousand lines with no network code: the app modules are about twelve thousand lines now, and ModelFiles.swift downloads S1-mini.
  • INSTALL.md: the clone pointed at the old speakup repository, and the text still mentioned a "Dictate and polish key" that no longer exists.

How the GIF was made

  • Real: a test copy built from the Hotkey: V is the default send key #68 branch, with its own settings (Live style, sounds off, no send key set, so V came from the default), handled the dictation. The release-to-paste time was 197 ms, and nothing between release and paste is cut or sped up.
  • Scripted: the key presses were synthetic, and the prompt was spoken by macOS text-to-speech through the speakers into the microphone. The GIF is silent.
  • Edited: one terminal row, where Claude Code showed an account usage notice after the send, is filled with the terminal background colour. Without the notice that row is empty.

The desktop behind the window is the same stand-in gradient as styles-dark.png.

Test plan

  • README renders on GitHub: the GIF plays, the navigation links jump to the right sections.
  • docs/USAGE.md and docs/PRIVACY.md render, and their styles picture follows the light or dark theme.
  • Every relative link and anchor in the changed files resolves (checked with a script).

Documentation only; nothing on the release-to-paste path changes, so no benchmark.

🤖 Generated with Claude Code

dinooo13 and others added 3 commits September 28, 2026 19:55
Holding Option+Space in Claude Code, the Live pill showing the words,
Right Option to send, the release pasting and sending the prompt. A toast
names the keys as they are pressed. The four-styles picture moves down to
"Choose your style".

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The README made each point three or four times: speed, privacy, the send
key and the agents each had a bullet, a section and a FAQ entry. Now a
short pitch, three sections (speed, privacy, agents), install moved up
and honest that it builds from source, one line per remaining feature, and
a FAQ of five questions the rest of the page does not already answer. The
name moves to the end.

The detail moves to docs/USAGE.md (keys, dictionary, learned corrections,
fillers, spoken punctuation, polish, the pill's styles, mute, languages,
long dictations, the CLI) and docs/PRIVACY.md. The privacy page no longer
says the app is five thousand lines with no network code: it is about
twelve thousand now, and ModelFiles.swift downloads S1-mini.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The clone still pointed at the old speakup repository, and Apple
Intelligence was said to power a "Dictate and polish key" that is now a
toggle; it powers learned corrections and, if picked, the polish.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@dinooo13 dinooo13 mentioned this pull request Sep 28, 2026
2 tasks
The default send key is V now (#68), reachable with the hand that holds
Option+Space. The hero GIF is re-recorded with it, its toast naming V, and
the README and usage page say V, one-handed, and that the send key needs
Accessibility like the paste.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@dinooo13
dinooo13 merged commit 9c5a612 into main Sep 28, 2026
@dinooo13
dinooo13 deleted the docs/readme-hero branch September 28, 2026 18:42
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