Key point
Remove review friction
Your project should be easy to open, understand, and trust. A reviewer should not need to message you for files, setup steps, or the demo link.
GitHub says the README is often the first thing a visitor sees in a repo. Put the goal, live demo, setup steps, and useful links near the top.
Your to-do
Build your share pack
Do each one yourself, then tap it to tick it off. The ticks are only a checklist for you: they are not marked or scored.
0 of 5 done
Example
Share pack example
Use specific words. Do not write like an ad. Say what the user does inside the app.
This example works for a college UPI expense project.
Project name: FeeFlow
One-line summary: A simple UPI expense tracker for college students.
One-sentence impact: Helps hostel and PG groups record shared payments, split bills, and avoid confusion.
Links: GitHub repo, live demo, portfolio page
README intro:
FeeFlow is a UPI expense tracker for college students.
It helps hostel and PG groups record shared payments, split bills, and settle dues without confusion.
Live demo: https://feeflow.vercel.app
GitHub: https://github.com/yourname/feeflow