Skip to content

Commit a17d334

Browse files
committed
update README examples gallery links
1 parent 23cc29c commit a17d334

1 file changed

Lines changed: 8 additions & 26 deletions

File tree

README.md

Lines changed: 8 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919

2020
## Why BeforeCode?
2121

22-
Most projects start coding too early. BeforeCode creates a planning workspace that captures the real idea first, asks for missing context, and then generates build-ready Markdown documentation.
22+
BeforeCode creates a planning workspace that captures the real idea first, asks for missing context, and then generates build-ready Markdown documentation.
2323

2424
| Without BeforeCode | With BeforeCode |
2525
|---|---|
26-
| Random template docs | Context-aware docs |
27-
| AI agents guess missing details | Missing details become open questions |
26+
| Generic docs | Context-aware docs |
27+
| Missing decisions hidden | Missing decisions become open questions |
2828
| PRD, TRD, QA drift apart | Docs share one source of truth |
2929
| Build starts before scope is clear | Build starts from reviewed context |
3030

@@ -83,19 +83,10 @@ flowchart TD
8383
## Quick start
8484

8585
```bash
86-
# Capture context and generate a planning workspace
8786
npx beforecode start
88-
89-
# Check which docs are present
9087
npx beforecode check
91-
92-
# Show readiness score by category
9388
npx beforecode score
94-
95-
# Run a project health audit
9689
npx beforecode doctor
97-
98-
# Generate AI coding handoff files
9990
npx beforecode handoff --name "My App"
10091
```
10192

@@ -115,17 +106,6 @@ your-project/
115106
└── ...
116107
```
117108

118-
## What it generates
119-
120-
| Area | Output |
121-
|---|---|
122-
| Context | `00-project-context.md`, `.beforecoderc.json` |
123-
| Discovery | `01-open-questions.md`, research report, business requirements |
124-
| Product | PRD, SRS, release scope, UX flows, permission matrix |
125-
| Engineering | TRD, database schema, API documentation, implementation plan |
126-
| Quality | QA test plan, readiness scoring, doctor audit |
127-
| AI handoff | `AGENTS.md`, `docs/ai-handoff.md` |
128-
129109
## Commands
130110

131111
| Command | Description |
@@ -159,12 +139,14 @@ your-project/
159139
- `--dry-run` previews generated files without writing.
160140
- Missing context is written as `TBD` instead of being invented.
161141
- `.beforecoderc.json` saves project settings for future commands.
162-
- Generated docs are starter structures; final product, security, legal, and architecture decisions remain human-owned.
163142

164143
## Examples and references
165144

166-
- [SaaS CRM example](examples/saas-crm/README.md)
167-
- [AI agent example](examples/ai-agent/README.md)
145+
- [Examples gallery](examples/README.md)
146+
- [SaaS CRM Pro reference pack](examples/saas-crm-pro/README.md)
147+
- [AI Video Editor reference pack](examples/ai-video-editor/README.md)
148+
- [Browser QA Agent reference pack](examples/browser-qa-agent/README.md)
149+
- [Example quality standard](examples/example-quality-standard.md)
168150
- [CLI usage guide](docs/cli-usage.md)
169151
- [Release runbook](docs/releasing.md)
170152
- [Reference material](docs/references.md)

0 commit comments

Comments
 (0)