Fill in these first
- Project name and one-line purpose: [name, purpose]
- Language and framework: [details]
- Main features: [list]
- Setup notes: [paste commands you run to install and start it]
- Environment variables: [names and what each does, never the values]
- Example usage: [a command, API call or screenshot description]
- Licence: [e.g. MIT, Apache 2.0, proprietary]
- Who reads this: [open source users, teammates, clients]
Task
Write a README.md that lets a new developer go from cloning the repository to a working run in under 15 minutes.
Output format
- Title and one-line summary.
- Features: up to seven bullet points.
- Requirements: versions of runtimes and tools.
- Installation: numbered steps with commands in code blocks.
- Configuration: | Variable | Required | Default | Description |
- Usage: two or three examples with expected output.
- Running tests.
- Project structure: a short tree of key folders with one line each.
- Contributing and licence.
Rules
- Commands must be copy-paste ready for the stated operating systems.
- Use placeholder values such as your-api-key for every secret.
- No badges, links or features that the inputs do not support.
- Keep sentences short; a README is scanned, not read.
Example
| DATABASE_URL | yes | none | Connection string for the main database |






