Build in Public README
A durable project home that distinguishes the current product, the open question, and the public progress log.
Use this when
Your project needs one stable URL before you begin sharing updates across feeds and communities.
The template
# [Project name]
[One literal sentence: what it is, who it helps, and the outcome.]
## Current state
This project currently can:
- [Working capability]
- [Working capability]
It does not yet:
- [Important limitation]
## Why this exists
[The observation, problem, or experience that started the project.]
## What I am testing
[The current assumption or question.]
## Try it
[Demo, installation, document, or contact instructions.]
## Progress
- YYYY-MM-DD: [Change] because [evidence or reason].
- YYYY-MM-DD: First public version.
## Feedback
[One focused question and the best place to respond.]
## Boundaries
[What is intentionally out of scope or kept private.]
## License
[License or usage terms.]Editing rules
Lead with the current state, not a long origin story. Remove badges that do not help a reader decide whether to use the project. Keep planned features separate from working features. Date meaningful changes.
Before publishing
- [ ] A stranger can understand the project from the first paragraph.
- [ ] Current capabilities and plans are visibly different.
- [ ] The primary link or setup path works.
- [ ] The feedback request is focused.
- [ ] Usage and contribution terms are clear.