Skip to content

docs: rework README into per-feature sections with runnable examples #96

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
deblasis merged 2 commits into from
Aug 23, 2026
Merged

docs: rework README into per-feature sections with runnable examples #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e09df5d
docs: rework README into per-feature sections with runnable examples
deblasis Aug 23, 2026
1748acd
docs: review fixes — capability claims made true
deblasis Aug 23, 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
6 changes: 3 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ network**. You describe services in a YAML manifest; stunt serves them on local
over real TLS with subdomain routing). Stateful behavior (databases, tokens, webhooks) comes from
adapters written in a **sandboxed Starlark** scripting layer.

**Install:** `brew install stuntapi/tap/stunt` · **Run from source:** `go run ./cmd/stunt` ·
**Install:** `brew install --cask stuntapi/tap/stunt` · **Run from source:** `go run ./cmd/stunt` ·
**One-shot demo:** `stunt demo`

> **Adapters are embedded.** All reference adapters ship INSIDE the binary
> (3.4 MB). `stunt catalog search` lists all 91 offline, and
> **Adapters are embedded.** All reference adapters ship INSIDE the binary.
> `stunt catalog search` lists all of them offline, and
> `stunt adapter add <name>` resolves a bundled adapter to an `embedded:<name>`
> source that `stunt up` extracts from the binary — no git clone, no network.
> Use `git:` / local-path sources for community or custom adapters.
Expand Down
Loading
Loading