Repository navigation
Update README for styles, vocabulary, and current setup flow - #211
Merged
Merged
Conversation
Document the Style menu and custom styles, the Enhanced transcripts switch, key terms and text shortcuts, and the tap-only/hold-only activation modes. Describe first-run setup and the Settings window as they are now, note in Privacy that the selected style's instructions are sent and that Developer mode keeps a local dictation log, and list the build prerequisites and the open -a step under Build from source. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
alexkroman
marked this pull request as ready for review
September 29, 2026 19:28
alexkroman
added this pull request to the merge queue
Sep 29, 2026
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
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.
Before: The README didn't mention styles, the Enhanced transcripts switch, text shortcuts, or the tap-only / hold-only activation modes. It described setup as a wizard whose window "later hosts settings". Privacy said key terms were the only user setting sent with a request and that Blurt "stores no … transcripts" without mentioning the Developer mode log. Build from source said it "needs only Xcode and Homebrew" and never said how to launch the dev build.
After: The Features list covers Styles and Vocabulary (key terms and text shortcuts), and the trigger bullet mentions the activation modes. Guided setup and Getting started match the current single setup screen, the Style menu, and the Settings window. Privacy now says the selected style's instructions are sent, text shortcuts are expanded locally, and opt-in Developer mode keeps a local dictation log. Build from source lists the prerequisites (Xcode 26+, Homebrew, an Apple Development certificate) and adds
open -a "Blurt Dev". The architecture tree'sConfig/line now names styles and text shortcuts. OnlyREADME.mdchanges.What & why
This is a docs-only refresh so the README matches what the app does today. Everything that was already accurate stays as it was: badges, links, the rest of Privacy, and the architecture notes.
How it was tested
Each new claim was checked against the source:
Sources/BlurtEngine/Config/StyleProfileStore.swift(profileLimit = 4),App/Blurt/Blurt/Wizard/StyleRow.swift(the "Style" pop-up), andSettingsWindowRoot.swift(the General / Styles / Vocabulary / Advanced panes and the Enhanced transcripts toggle).EnhancedTranscriptsStore.swift.AssemblyAITranscriber.swift(customStyle, appended tollm_instruction).TextShortcutStore.swift.KeyTermsStepView.swift,TextShortcutsSection.swift.Hotkey/TriggerActivation.swift,HotkeyStepView.swift.MicrophoneStepView.swift.WizardView.swift(API key and permissions only).DeveloperModeStore.swift,Pipeline/DictationLog.swift,DeveloperSection.swift.CONTRIBUTING.md,scripts/bootstrap.sh,scripts/dev-build.sh.scripts/check.sh --portablepasses on Linux, and a standalonemarkdownlint README.mdpasses too (the portable run skipped markdownlint because it isn't installed here). The Swift build and tests weren't run locally because this is a docs-only change, so CI on macOS decides the rest.scripts/check.shpasses (or CI will, if I'm not on a Mac)🤖 Generated with Claude Code