GitHub Profile README Generator

Your Information

Basic Information

Name *

Please enter your name.

GitHub Username *

Please enter a valid GitHub username (letters, numbers, single hyphens).

Short Bio

Location

Banner Image URL (Optional)

Social Links

Skills & Technologies

Other Skills (Comma-separated)

About Me Sections

🌱 Currently Learning

🔭 Working On

💬 Ask Me About

📫 How to Reach Me (Email)

👨‍💻 Portfolio Link

📝 Blog/Articles Link

📄 Resume Link

⚡ Fun Fact

GitHub Add-ons

WakaTime Username Used for WakaTime stats card.

Featured/Pinned Repositories List repos to feature using `username/repo-name` format.

Blog Post Feed RSS/Atom URL URL for the blog-post-workflow action.

Include Elements

GitHub Stats Card

Top Languages Card

GitHub Streak Stats

Profile Views Counter

Twitter Follow Badge

GitHub Sponsor Button

Configuration & Actions

Template

Stats Card Theme

Generated README.md

Start filling the form to see the preview...

Fill in your details in the form on the left. Required fields are marked with *.
Use the "Fetch" button next to the GitHub username input to prefill some basic info (Name, Bio, Location, Blog, Twitter) directly from your GitHub profile (only fills empty fields).
Select your skills by clicking the badges. Add any other skills in the text input below.
Add your social media usernames/IDs for the predefined platforms. Use the "Add Custom Link" button for other websites.
Fill in the "About Me" sections as desired.
Provide optional usernames/links for GitHub Add-ons like WakaTime or Pinned Repos.
Use the checkboxes to include/exclude specific elements like Stats Cards or Badges.
Choose a template and a theme for the Stats Cards.
The preview on the right updates automatically as you type or make selections.
Use the "Save Config" button to store your current inputs in your browser's LocalStorage. Use "Load Config" to retrieve them later.
Once you're happy with the preview, click the "Copy Markdown" button.

Go to github.com/new to create a new repository.
Name the repository exactly the same as your GitHub username (e.g., if your username is `octocat`, name the repository `octocat`). This is a special repository!
Make sure the repository is set to **Public**.
Initialize the repository with a README file (you can check the box during creation or add one later).
Edit the `README.md` file in your new repository.
Paste the Markdown you copied from this generator into the editor.
Commit the changes directly to the `main` (or `master`) branch.
Visit your GitHub profile page (e.g., `github.com/octocat`), and your new profile README should be displayed!