Skip to content

Commit 3b62a0e

Browse files
committed
docs(readme): top-of-page Quickstart with three audience paths
1 parent 421165e commit 3b62a0e

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,15 @@ Point AI agents at any indexed repo and they get a current, schema-validated gra
1212

1313
> **Status:** private MVP under [`amacsmith/understand-quickly`](https://github.com/amacsmith/understand-quickly). Will move to a public org once core flows are battle-tested. Live registry at <https://amacsmith.github.io/understand-quickly/>.
1414
15-
[**Browse the registry **](https://amacsmith.github.io/understand-quickly/) · [**Add your repo**](#add-your-repo) · [**Agent quickstart**](#agent-quickstart) · [**Design spec**](docs/superpowers/specs/2026-05-07-understand-quickly-registry-design.md)
15+
[**Browse →**](https://amacsmith.github.io/understand-quickly/) · [**Add your repo (wizard)**](https://amacsmith.github.io/understand-quickly/add.html) · [**Agent quickstart**](#quickstart) · [**Design spec**](docs/superpowers/specs/2026-05-07-understand-quickly-registry-design.md)
1616

1717
</div>
1818

1919
---
2020

2121
## Contents
2222

23+
- [Quickstart](#quickstart)
2324
- [Why](#why)
2425
- [How it works](#how-it-works)
2526
- [Zero cost](#zero-cost)
@@ -32,6 +33,27 @@ Point AI agents at any indexed repo and they get a current, schema-validated gra
3233
- [Roadmap](#roadmap)
3334
- [License](#license)
3435

36+
## Quickstart
37+
38+
**I'm an AI agent / SDK user.**
39+
```bash
40+
curl -fsSL https://amacsmith.github.io/understand-quickly/registry.json
41+
```
42+
Pick entries with `status: "ok"`. Fetch `entry.graph_url`. Cache by `last_sha`. That's the whole API.
43+
44+
**I want to register my repo.** Pick the path that fits:
45+
- 🖱️ **30-second wizard:** [Add your repo →](https://amacsmith.github.io/understand-quickly/add.html). Fills the issue for you; the bot opens the PR.
46+
- 💻 **From your terminal:** `npx @understand-quickly/cli add` — auto-detects everything.
47+
- ✍️ **Manual PR:** see [Add your repo](#add-your-repo) below.
48+
49+
**I'm a developer / contributor.**
50+
```bash
51+
git clone https://github.com/amacsmith/understand-quickly
52+
cd understand-quickly
53+
npm install && npm test
54+
```
55+
Then read [`CONTRIBUTING.md`](./CONTRIBUTING.md).
56+
3557
## Why
3658

3759
Tools like [Understand-Anything](https://github.com/Lum1104/Understand-Anything), [GitNexus](https://github.com/abhigyanpatwari/GitNexus), and [code-review-graph](https://github.com/tirth8205/code-review-graph) turn a codebase into a queryable knowledge graph. The graph is JSON. Today there is no shared, current, machine-readable index of which public repos publish one.
@@ -109,6 +131,8 @@ Schemas: [`schemas/`](./schemas/). Each `format` value (e.g. `understand-anythin
109131

110132
## Add your repo
111133

134+
> **Want the easy path?** Use the [wizard](https://amacsmith.github.io/understand-quickly/add.html) or `npx @understand-quickly/cli add`. The instructions below describe the manual-PR flow.
135+
112136
1. Run [Understand-Anything](https://github.com/Lum1104/Understand-Anything) (or any supported tool) locally; commit `.understand-anything/knowledge-graph.json` to your repo.
113137
2. Fork this repo.
114138
3. Append an entry to `registry.json`. Use whichever format your tool emits:

0 commit comments

Comments
 (0)