GitHub profile README generator with skill badges and stats cards

How to use the GitHub profile README generator

1. Type your Name and a one-line Tagline. Add a short About paragraph if you want one.
2. Fill in any of Currently working on, Currently learning and Ask me about. Empty fields are skipped.
3. List your Skills (comma-separated), for example Python, Rust, Kubernetes.
4. Add your GitHub username and any of LinkedIn profile ID, X username, Website and Public email.
5. Tick Stats card, Top languages card or Streak card, then copy the README.md from the output.

What it does and when to use it

GitHub shows a special README at the top of your profile when a public repository has the same name as your account. This tool writes that file without you looking up badge URLs or Markdown syntax. Use it for a new profile, before a job search, or when your profile lists tools you no longer use.

The tool writes the profile README only. For a project README, use the README generator. To automate checks in the same repository, see the GitHub Actions generator, and pick a licence for your code with the licence generator.

How it works

The output is plain Markdown, built in your browser as you type:

• A heading # Hi, I'm <name>, your tagline in bold, then a bullet list of the “currently” lines and your email.
• A Skills section with one shields.io badge per skill. Known skills get their brand colour and logo.
• A Find me line with links. A full LinkedIn URL is cut down to the profile ID, @ is removed from usernames, and https:// is added to a website that lacks it.
• A GitHub stats section with image links to the cards you ticked, only when a GitHub username is set.

GitHub’s own guide to managing your profile README explains where the file must live.

Worked examples

A data engineer with two cards. Name Lena, tagline Data engineer, skills Python, Rust, Kubernetes, GitHub username lena-dev, the “currently” fields empty, Stats card and Top languages card ticked. The skills line starts with:

![Python](https://img.shields.io/badge/Python-3776AB?style=flat-square&logo=python&logoColor=white)

The stats section then holds the stats card and the top-languages card for lena-dev. Because LinkedIn was empty, the Find me line holds only the GitHub link.

One skill, no cards. With skills Go and Stats card unticked, the only badge uses logo=go with Go’s blue 00ADD8, and the stats section is left out.

Limits and tips

• Check every link before you commit; a username typo breaks the stats cards.
• Stats cards are not GitHub data you control. They are pictures from outside services and can break or change.
• The tool does not upload anything or touch your GitHub account. You still create the repository and commit the file yourself.