Skip to content

docs: reflect cli-as-default-feature in README/CLAUDE.md/CHANGELOG (Refs #55)#57

Open
noahgift wants to merge 1 commit intomainfrom
docs/cli-default-install
Open

docs: reflect cli-as-default-feature in README/CLAUDE.md/CHANGELOG (Refs #55)#57
noahgift wants to merge 1 commit intomainfrom
docs/cli-default-install

Conversation

@noahgift
Copy link
Copy Markdown
Contributor

Summary

  • README: drop --features cli from install snippets, clarify library-only consumers should opt out via default-features = false
  • CLAUDE.md: add cargo install --path . to the canonical build commands; flip WASM build to opt out of cli + parallel
  • CHANGELOG: document the BREAKING (build-only) flip in [Unreleased] so the next release notes carry it

Why

PR #56 already shipped the code change but the docs still pointed users at the old --features cli install path and the dropped whisper-apr-cli alias. This is a follow-up doc-only refresh.

Test plan

  • cargo install whisper-apr (no flags) lands whisper-apr on PATH (verified locally)
  • WASM build still works with --no-default-features --features wasm
  • cargo build --release (default features) succeeds with cli compiled in

🤖 Generated with Claude Code

…efs #55)

PR #56 made `cli` a default feature and dropped the `whisper-apr-cli` bin
alias. Docs were still telling users to invoke `cargo install whisper-apr
--features cli` and reference the old alias. Refresh:

- README "## Usage" + "## Installation" + "## CLI" — drop the `--features cli`
  flag, clarify library-only consumers should opt out via
  `default-features = false` and pick `["std", "simd", "parallel"]`.
- CLAUDE.md "## Build Commands" — add `cargo install --path .` line so the
  next agent reading this knows the canonical install path; flip the WASM
  build to `--no-default-features --features wasm` so cli + parallel don't
  drag in for browser targets.
- CHANGELOG "## [Unreleased]" — document the BREAKING (build-only) change
  for the default-feature flip and the bin-alias removal, plus the
  `load_audio_samples` fallback fix that was bundled with the lint-debt
  cleanup commit on the same PR.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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