Skip to content

Refresh README with updated feature descriptions and examples#111

Merged
alexkroman merged 3 commits into
mainfrom
claude/zealous-shannon-sgzy8z
Jun 12, 2026
Merged

Refresh README with updated feature descriptions and examples#111
alexkroman merged 3 commits into
mainfrom
claude/zealous-shannon-sgzy8z

Conversation

@alexkroman

Copy link
Copy Markdown
Collaborator

Summary

Updated the README to better reflect the current CLI capabilities and improve clarity for new users. This is primarily a documentation refresh with no code changes.

Key changes

  • Feature descriptions: Expanded the intro to highlight support for URLs, YouTube/podcast pages, and WER benchmarking; clarified that assembly init now includes dev/share/deploy commands for running and deploying apps
  • Installation section: Simplified pipx/uv instructions and consolidated platform-specific dependency notes into a single paragraph focused on live-audio commands
  • Authentication: Reorganized to lead with browser login (recommended) and clarify that environment variables are checked first and ideal for CI
  • Getting started: Restructured from verbose separate sections into a concise guided tour followed by quick command examples, making it easier for new users to jump in
  • Key features: Reordered and refined descriptions; added details about app deployment capabilities and clarified which commands need extra dependencies
  • Quick examples: Reorganized examples to show practical use cases (text extraction, batch processing, piping, LLM prompting, code generation) with clearer explanations
  • Development section: Condensed setup and testing instructions into compact command blocks with inline comments

Notable details

  • Maintained all technical accuracy while improving readability and flow
  • Emphasized the "no boilerplate" and "pipeline-friendly" value propositions more clearly
  • Clarified dependency requirements: only live-audio commands (stream, agent) need PortAudio and ffmpeg; plain transcribe needs neither
  • Improved the progression from "getting started" to "quick examples" to "development" for different audience levels

https://claude.ai/code/session_018JPSR8ot6yVX4DKRftEEq5

- State the PortAudio/ffmpeg extras note once instead of in both install
  sections, and stop repeating the same feature pitch in 'Why' and
  'Key Features'
- Collapse the one-command-per-block example sprawl into annotated,
  task-grouped code blocks (getting started, output selection, batching,
  piping, --show-code)
- Mention the assembly dev / share / deploy app workflow and fold WER
  benchmarking into the intro
- Fold the auth options into prose and trim Contributing to one block

https://claude.ai/code/session_018JPSR8ot6yVX4DKRftEEq5
@alexkroman alexkroman enabled auto-merge (squash) June 12, 2026 14:25
@alexkroman alexkroman merged commit 12a8ef2 into main Jun 12, 2026
16 checks passed
@alexkroman alexkroman deleted the claude/zealous-shannon-sgzy8z branch June 12, 2026 14:55
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.

2 participants