Project
Rewrite the READMEs on your three best repositories
Three READMEs rewritten to the same six-part structure, on the three repositories you would actually send to a hiring manager.
- Line one is the pitch. What it does and who it is for, under 20 words, above everything else. Not "a project I built to learn React".
- Show it working. A screenshot, a GIF, or a pasted terminal session with real output, inside the first screen of the page.
- Five commands to running. Clone, install, configure, seed, run — copy-pasteable, with the exact language and tool versions you tested. Then run them yourself in a fresh clone on a clean machine and fix everything that breaks.
- One decision, defended. A short section naming a real trade-off — the database, the framework, the schema shape — with the alternative you rejected and why.
- State the limits. What it does not do, what breaks at scale, what you would fix first. This reads as judgement, not weakness.
- Test the pitch on an outsider. Sixty seconds, someone outside your field, then ask what the project does. Rewrite line one until they get it right.
Scope guard: no badges that do not report a real status, no roadmap section, no architecture diagram for 400 lines of code.