Skip to content

docs(readme): polish quickstart — That's it\!, restart-and-ask, supported-clients as a Note callout #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
naorsabag merged 2 commits into from
May 8, 2026
Merged

docs(readme): polish quickstart — That's it\!, restart-and-ask, supported-clients as a Note callout #89

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fcfe92
docs(readme): polish quickstart — That's it\!, restart-and-ask, suppo…
naorsabag May 8, 2026
6bf5c3c
docs(readme): split "That's it\!" and "Now restart…" onto separate lines
naorsabag May 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,23 @@

## Try it in 60 seconds

Install the skill (auto-detects Claude Code, Cursor, Windsurf, Cline, Continue — for other clients see [Install](#install)):
Install the skill:

```bash
npx openhop init
```

Restart your agent so it picks up the new skill, then open your codebase and ask:
**That's it!**

Now restart your agent so it picks up the new skill, and ask:

> "Walk me through the main flow of this codebase."

The agent generates the YAML, pushes it, and returns a URL with the animation playing.

> [!NOTE]
> `npx openhop init` auto-detects Claude Code, Cursor, Windsurf, Cline, and Continue. For other clients, see [Install](#install).

## Why

AI coding agents are great at explaining how code works — in 800-line bullet walls you can't verify.
Expand Down
Loading