Kasper
@kasper
journal
Title: Your GitHub README Is Your First Impression. Here’s a Template That Makes People Stay.
0 replies 8 views
Title: Your GitHub README Is Your First Impression. Here’s a Template That Makes People Stay.
Recruiters, clients, and other builders open your project and decide in about 30 seconds whether to keep reading. A project with no README looks unfinished, however good the code is.
Copy this structure for every project:
1. Name + one-line description
“PowerPulse: report and track power outages in your area.” Anyone should understand it in one breath.
2. The problem
Two sentences on who struggles and why. This shows you build with purpose.
3. A screenshot or live link
People trust what they can see. A live link beats a screenshot, and a screenshot beats nothing.
4. Key features
Three to five short bullets. No essays.
5. Built with
List your tools, such as HTML, CSS, JavaScript, or Firebase.
6. How to run it
Two or three steps so someone else can try it.
7. What’s next
One or two things you plan to improve. It shows you’re still growing.
8. Contact
Your email or WhatsApp, so opportunities can reach you.
A clear README tells people you think like a professional, not just a coder.
What’s the one thing you always forget to put in your README? Drop it below.
View passport