beads/docs/QUICKSTART.md
Ben Madore 3b39ce577a
docs: update user-facing URLs from steveyegge/beads to gastownhall/beads
Co-authored-by: Ben Madore <823868+madorb@users.noreply.github.com>
2026-04-24 08:17:42 -07:00

23 lines
1.1 KiB
Markdown

# Beads Quickstart
**Canonical documentation:** [Quick Start (published)](https://gastownhall.github.io/beads/getting-started/quickstart) — browse the full tutorial with navigation and search.
**Source in this repo:** [website/docs/getting-started/quickstart.md](../website/docs/getting-started/quickstart.md) (what GitHub Pages builds from; the `docs/` copy here is a pointer for deep links and agents).
## Ultra-short path
1. Install `bd` — see [Installation](INSTALLING.md) or the [site installation page](https://gastownhall.github.io/beads/getting-started/installation).
2. In your project: `bd init`
3. Create work: `bd create "My task" -p 1` then `bd ready`
For dependencies, sync, Notion, migrations, and maintenance, use the [full Quick Start](https://gastownhall.github.io/beads/getting-started/quickstart) linked above.
---
## Why Beads?
See **[Why Beads?](https://gastownhall.github.io/beads/getting-started/quickstart#why-beads)** on the documentation site.
## Dependencies
See **[Add dependencies](https://gastownhall.github.io/beads/getting-started/quickstart#add-dependencies)** on the documentation site (blocking dependencies and `bd dep`).