docs(README): add Quick Start section — plugin recommended, CLI second#110
Merged
Conversation
dadachi
force-pushed
the
docs/quick-start-section
branch
from
83b7c86 to
ed4ce5a
Compare
Mirror the hyperframes README pattern: surface the install paths up front with the Claude Code plugin as the recommended option (bundles MCP wiring + adds /walk-app), standalone CLI as the no-editor alternative, and a one-line pointer to the MCP server for Cursor/Cline/Goose users. The detailed Usage section is unchanged — it remains the reference. This just gives readers a scannable on-ramp before they hit Why this exists.
dadachi
force-pushed
the
docs/quick-start-section
branch
from
ed4ce5a to
c8d350d
Compare
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
1 participant
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.
Mirrors the hyperframes README pattern: surface install paths up front, before "Why this exists," so readers can try the agent in seconds rather than scrolling through the Usage reference first.
Layout
Why plugin is recommended
Strictly more capable than the bare CLI — bundles the MCP wiring and adds
/walk-app(drive the running app on a simulator/emulator, screenshots inline). The CLI stays as the no-editor alternative; the MCP server appears as a callout for non-Claude-Code MCP clients.What's not changed
## Usagesection is untouched and remains the reference (full flag table, output layout, MCP/plugin prose). Slight overlap with Quick Start is intentional — Quick Start is the on-ramp, Usage is the manual.Diff
+33 / -0. Inserted between the status block and
## Why this exists.🤖 Generated with Claude Code