<package-or-app-name> README Template

Copy this structure into top-level app/package READMEs. Remove sections that truly do not apply.

Purpose

Explain why this app/package exists in 1–3 sentences.

Public API / Entrypoints

• src/index.ts — exported package API
• src/main.ts — application entrypoint
• CLI / HTTP / worker entrypoints, if applicable

Key Commands

pnpm --filter <package> dev
pnpm --filter <package> test
pnpm --filter <package> build

Ownership & Consumers

Role	Notes
Owner	Team/person responsible for review
Consumers	Apps/packages that depend on this module

Related Docs

• App Structure
• Frontend Architecture
• Add relevant ADRs, schemas, protocols, or runbooks.

Common Pitfalls

• List constraints that are easy to violate.
• Prefer concrete examples over broad warnings.