How to use the GitHub Profile README Generator
- 1. Add your detailsName, a one-line intro, what you are working on and learning.
- 2. List skills and linksSkills become badges; add your GitHub username and LinkedIn.
- 3. Download README.mdPut it in a public repository named exactly like your username.
How the profile README works
GitHub shows a special README at the top of your profile page when you create a public repository with exactly your username as its name, for example asha-dev/asha-dev, containing a README.md. It is the first thing a recruiter sees when they open your GitHub link from your resume.
A good profile README is short and scannable: who you are, what you are building now, your main skills and how to reach you. The generator adds:
- Skill badges from shields.io, a free open-source badge service.
- GitHub stats and top-languages cards from the open-source github-readme-stats project, which update automatically as you commit.
- Links to LinkedIn, your portfolio and GitHub.
Worked example and tips
The sample for Asha Verma produces a 24-line README.md with an About me section of three points, 8 skill badges (JavaScript, React, Node.js, Express, MongoDB, SQL, Git and Python), two links and the stats cards for @asha-dev. The preview here shows badges as labels, because images from other sites are not loaded on this page; on GitHub they appear as coloured badges.
- Pin your 4–6 best repositories under the README, each with its own clear README and a live link.
- Keep it honest: list skills you can talk about in an interview.
- Fill in the GitHub "About" fields too: name, bio, location and website.
If a stats card fails to load on GitHub, the public service may be busy. You can remove that line or host your own copy of the project.
Frequently asked questions
Where do I put the README?
In a public repository named exactly the same as your GitHub username, at the top level, named README.md.
Can I edit it later?
Yes. Edit README.md on GitHub any time; the profile updates at once.
Are the badges free?
Yes. shields.io and github-readme-stats are free open-source services.
Is the github profile readme generator free?
Yes, it is free. Generating your first README asks for your name and WhatsApp number once. After that, the github profile readme generator and every other Uncodemy tool open with no form.