How to use the README.md Generator
- 1. Describe your projectEnter the name, a one-line description, features and tech stack.
- 2. Add setup detailsList install commands, usage, demo link, screenshot and license.
- 3. Get the filePress Generate to see the preview, then copy or download README.md.
What a good README contains
Recruiters and other developers often decide in under a minute whether a GitHub repo is worth a look, and the README is the first thing they see. A clear README answers four questions: what is this, what can it do, how do I run it and who made it.
This generator writes these sections in a standard order: title, badges, description, live demo, screenshot, Features, Tech Stack, Getting Started with a bash code block, Usage, Contributing, License and Author. Empty optional fields are skipped, so you never get blank headings.
Example output
Worked example: with the sample values (Expense Tracker, three features, stack "React, Node.js, Express, MongoDB" and repo yourname/expense-tracker), the Getting Started block becomes:
git clone https://github.com/yourname/expense-tracker.git
cd expense-tracker
npm install
npm run devThe summary shows 3 features, 4 technologies, and the badge line links to shields.io images for stars and the MIT license.
Tips for a stronger project page:
- Add a real screenshot or GIF. Upload it to the repo's issues or an
assetsfolder and paste its full URL. - Write features as results ("Export to CSV"), not code details.
- Pick a license. Without one, others are not legally allowed to reuse your code.
- Keep the install steps copy-paste ready and test them on a fresh clone.
Frequently asked questions
Where do I put README.md?
Save it in the top folder (root) of your repository. GitHub shows it automatically on the repo's main page.
Will the badges work for a private repo?
Public shields.io badges such as stars only work for public repos. Untick the badge option if your repo is private.
Which license should I choose?
MIT is the most common choice for student and portfolio projects because it is short and lets anyone reuse the code with credit.
Is the generator free?
Yes. Fill in the form at your own pace. We ask for a name and WhatsApp number once when you generate your first README, then all Uncodemy tools open directly.