Skip to content

Commit ed4ce5a

Browse files
committed
docs(README): add Quick Start section — plugin recommended, CLI second
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.
1 parent d6ae26b commit ed4ce5a

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,41 @@ npx nativeapptemplate-agent "a walk-in clinic queue for small veterinary practic
2121
2222
---
2323

24+
## Quick Start
25+
26+
### Option 1: Claude Code plugin (recommended)
27+
28+
Install the plugin once, then drive the agent with two slash commands — `/nativeapptemplate-agent:generate-app` (generate → validate → explain) and `/nativeapptemplate-agent:walk-app` (launch the app on a simulator/emulator and walk its UI via `mobile-mcp`, screenshots inline).
29+
30+
```bash
31+
/plugin marketplace add nativeapptemplate/nativeapptemplate-agent
32+
/plugin install nativeapptemplate-agent@nativeapptemplate
33+
```
34+
35+
Then in Claude Code:
36+
37+
```
38+
/nativeapptemplate-agent:generate-app a walk-in clinic queue for small veterinary practices. project name is VetClinic.
39+
```
40+
41+
Or load it locally without the marketplace: `claude --plugin-dir ./plugin`. See [`plugin/README.md`](./plugin/README.md) for the reference card, and the [A-to-Z plugin guide](./docs/PLUGIN-GUIDE.md) for a full walkthrough.
42+
43+
### Option 2: Standalone CLI
44+
45+
No editor required — runs anywhere Node 22+ is installed.
46+
47+
```bash
48+
npx nativeapptemplate-agent "a walk-in clinic queue for small veterinary practices" --project-name="VetClinic"
49+
```
50+
51+
Generated output appears under `./out/<slug>/`. See [Usage](#usage) for rename overrides and report flags.
52+
53+
> **Pass a project name.** `--project-name` (or "project name is …" in the plugin) pins the Pascal project name, output slug (`out/vet-clinic/`), Xcode scheme, and display name across all three platforms. Omit it and the planner picks one — fine for one-off exploration, but it'll differ across re-runs.
54+
55+
> Using Cursor, Cline, Goose, or another MCP-capable editor? The generator also ships as an MCP server: `npx -y -p nativeapptemplate-agent nativeapptemplate-agent-mcp` exposes a `generate_app` tool you can wire into your editor's MCP config.
56+
57+
---
58+
2459
## Why this exists
2560

2661
Most "AI builds an app" tools stop at a single web frontend. The real pain for anyone shipping a mobile product is that the *same* domain has to be implemented three times — multi-tenant Rails API, native iOS, native Android — each with its own idioms, and keeping them consistent is where weeks disappear.

0 commit comments

Comments
 (0)