Skip to content

docs: update Quick start example to markdown prompt format #278

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
pelikhan merged 2 commits into from
Jul 29, 2026
Merged

docs: update Quick start example to markdown prompt format #278

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a55c9eb
Update README Quick start to use markdown prompt format with nested r…
Copilot Jul 29, 2026
8da57e8
Update README.md
pelikhan Jul 29, 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
14 changes: 6 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,12 @@ gh skills clone githubnext/rig

## Quick start

```ts
import { agent, p, s } from "rig";
Save as `program.md`:

````md
# Review Git Diff

```rig
// Agent role: review the current diff and return prioritized findings.
const reviewDiff = agent({
model: "small",
Expand All @@ -31,12 +34,7 @@ const reviewDiff = agent({

export default reviewDiff;
```

Run it:

```bash
echo "check this" | node skills/rig/rig.ts program.ts
```
````

## Full API reference

Expand Down