Skip to content

README Template ​

markdown
# Project Name

One-sentence description.

## Problem

What problem the product solves and for whom.

## Scope

- In scope
- Out of scope

## Architecture Summary

- Runtime and deployment model
- Primary dependencies
- Data stores and integrations

## Quick Start

\`\`\`bash
git clone <repo>
cd <repo>
cp .env.example .env.local
<install command>
<start command>
\`\`\`

## Operational Notes

- Health endpoint
- Required background jobs
- Required third-party services

## Testing

\`\`\`bash
<lint command>
<test command>
<build command>
\`\`\`

## Deployment

Point to the deployment guide and rollback procedure.

## Documentation

- ADRs
- Runbooks
- API docs
- Security policy