Write a README that makes client handoff easier.
A delivery README is not just a public project description. It is the document a client, teammate, or future maintainer opens when they need to run, deploy, or safely change the app.
What a client handoff README should answer
- What the project does and what is in scope
- How to install and run it locally
- Which environment variables and services are required
- How deployments work and where logs live
- Known limitations, maintenance notes, and next steps
- How future changes should be reviewed and shipped
A practical README flow for delivery
# Client Project ## Overview What the app does, who uses it, and what was delivered. ## Local Setup Install, database, seed, and run commands. ## Configuration Environment variables, OAuth callbacks, webhooks, and services. ## Deployment Hosting provider, build command, migrations, and rollback notes. ## Maintenance Notes Known edge cases, support boundaries, and recommended next steps.