Refactor README in the style of leading CLI READMEs#142
Merged
Conversation
Restructure to combine patterns from the Codex, Gemini, and Antigravity CLI READMEs: an up-front Quickstart, a features-at-a-glance command table, GitHub [!NOTE]/[!WARNING] callouts, a collapsible system-deps block, Option 1/2 authentication with best-for guidance, a categorized Documentation section, and grouped legal links. https://claude.ai/code/session_01GAo4XYyoxt8LgcYQU3sN1d
Complete the features table against the real command surface (add caption and transcripts/sessions, move sessions out of the account row, reorder rows to match the CLI's own help grouping), point the karaoke example at assembly caption, mirror the brew trust line in Quickstart so either install block copy-pastes safely, and dedupe repeated onboard, AGENTS.md, and --show-code mentions. https://claude.ai/code/session_01GAo4XYyoxt8LgcYQU3sN1d
Main's updated Key features prose section conflicted with this branch's removal of it in favor of the features-at-a-glance table. Kept the table and folded main's new facts into it (dub accepts URLs, clip's --video keeps the picture); dropped the now-redundant caption pointer since main's karaoke example uses assembly caption directly. https://claude.ai/code/session_01GAo4XYyoxt8LgcYQU3sN1d
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
2 participants
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.
Restructure to combine patterns from the Codex, Gemini, and Antigravity
CLI READMEs: an up-front Quickstart, a features-at-a-glance command
table, GitHub [!NOTE]/[!WARNING] callouts, a collapsible system-deps
block, Option 1/2 authentication with best-for guidance, a categorized
Documentation section, and grouped legal links.
https://claude.ai/code/session_01GAo4XYyoxt8LgcYQU3sN1d