docs: comprehensive README rewrite with complete service specification #13

Merged
sneak merged 3 commits from feature/comprehensive-readme-rewrite into main 2026-03-02 00:43:56 +01:00

3 Commits

Author SHA1 Message Date
cfa4873cc4 Merge branch 'main' into feature/comprehensive-readme-rewrite
All checks were successful
check / check (push) Successful in 4s
2026-03-02 00:43:39 +01:00
clawbot
1e8becc4bd fix: correct 4 factual inaccuracies in README
All checks were successful
check / check (push) Successful in 1m2s
- Fix webhook route: /hooks/<uuid> → /webhook/{uuid} (matches routes.go)
- Fix CGO claims: acknowledge mattn/go-sqlite3 transitive dep requires CGO at build time
- Fix database architecture: distinguish current single-DB from planned Phase 2 per-webhook split
- Fix static file descriptions: Bootstrap CSS/jQuery JS → actual style.css and app.js
2026-03-01 10:22:08 -08:00
clawbot
87ff336013 docs: comprehensive README rewrite with complete service specification
All checks were successful
check / check (push) Successful in 9s
Rewrite README.md from a basic scaffold into a complete service
description and specification document.

- Define naming scheme: Processor → Webhook, Webhook → Entrypoint
- Document all 8 data model entities with field tables and relations
- Describe separate database architecture (main app DB + per-webhook
  event DBs)
- Document all API endpoints (current and planned)
- Detail middleware stack, authentication, security measures
- Include complete package layout with file descriptions
- Add request flow diagram
- Reorganize TODO into phased roadmap with issue links
- Set license to MIT

closes #3
2026-03-01 10:11:48 -08:00