The audience for this is Home Assistant users, who are not necessarily
developers. The instructions assumed too much and buried the step most likely
to trip someone up.
Biggest fix: connecting to Home Assistant is two steps, not one. Adding the
Wyoming integration does nothing on its own -- the assistant keeps using
whatever speech-to-text it used before until you change it under Settings ->
Voice assistants. That was previously half a sentence at the end of a
paragraph, and its failure mode is silent: everything looks installed and
nothing improves. It is now its own numbered step with an explanation.
Also adds:
- "Check it's working" and "Troubleshooting", the latter drawn from failures
actually hit while building and deploying this, including the wrong-Python
error and the service-did-not-start-after-changing-user case.
- IP address guidance that survives contact with a real machine. Checking on
the deployment host showed five addresses -- two Parallels interfaces, a
Tailscale one, and two real ones -- so the docs now say which to ignore.
The obvious `ipconfig getifaddr en0` was rejected: it returns nothing there.
- Requirements now lead with `brew install python@3.13` rather than an
explanation of lzma; the reasoning moved into a collapsed block.
- A plain-English guide to reading the benchmark table, and an explicit note
that the numbers are a snapshot nothing re-runs automatically.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The benchmark table, analysis, caveats and reproduction steps were about half
the README and are reference material, not something you read to install this.
They move to BENCHMARKS.md, leaving a four-row summary and a link.
Stale claims found while auditing, all now corrected against the running
system:
- "37 unit tests" -- there are 44.
- The Logs section claimed each request logs the transcript. It has not since
transcripts moved behind --debug, and the claim directly contradicted the
Security section two headings later.
- The notable-tests list predated the security work and omitted the buffer cap
and transcript-privacy tests.
- Title said wyoming-parakeet; the repo is wyoming-parakeet-mlx.
Also documents the server's own flags, which were only discoverable via
--help or the Security section, and drops the duplicated speed claim now that
Performance carries the numbers.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
aharrison-fullerandClaude Opus 5