rahuldkjain / github-profile-readme-generator

<p align="center"> <a href="https://rahuldkjain.github.io/github-profile-readme-generator"> <img alt="GitHub Profile Readme Generator" src="./src/images/mdg.png" width="60" /> </a> </p> <h1 align="center"> GitHub Profile README Generator </h1> <p align="center"> <a href="https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/LICENSE" target="blank"> <img src="https://img.shields.io/github/license/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator license" /> </a> <a href="https://github.com/rahuldkjain/github-profile-readme-generator/fork" target="blank"> <img src="https://img.shields.io/github/forks/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator forks"/> </a> <a href="https://github.com/rahuldkjain/github-profile-readme-generator/stargazers" target="blank"> <img src="https://img.shields.io/github/stars/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator stars"/> </a> <a href="https://github.com/rahuldkjain/github-profile-readme-generator/issues" target="blank"> <img src="https://img.shields.io/github/issues/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator issues"/> </a> <a href="https://github.com/rahuldkjain/github-profile-readme-generator/pulls" target="blank"> <img src="https://img.shields.io/github/issues-pr/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator pull-requests"/> </a> <a href="https://discord.gg/HHMs7Eg" target="blank"> <img src="https://img.shields.io/discord/735303195105951764?label=Join%20Community&logo=discord&style=flat-square" alt="join discord community of github profile readme generator"/> </a> </p> <p align="center"><img src="/public/demo.gif" alt="github-profile-readme-generator gif" /></p> <p align="center"> <a href="https://rahuldkjain.github.io/github-profile-readme-generator" target="blank">View Demo</a> · <a href="https://github.com/rahuldkjain/github-profile-readme-generator/issues/new/choose">Report Bug</a> · <a href="https://github.com/rahuldkjain/github-profile-readme-generator/issues/new/choose">Request Feature</a> </p> <p align="center"> <i>Loved the tool? Please consider <a href="https://paypal.me/rahuldkjain/10">donating</a> 💸 to help it improve!</i> </p> <p align="center"> <a href="https://www.paypal.me/rahuldkjain"><img src="https://img.shields.io/badge/support-PayPal-blue?logo=PayPal&style=flat-square&label=Donate" alt="sponsor github profile readme generator"/> </a> <a href='https://ko-fi.com/A0A81XXSX' target='_blank'><img height='23' width="100" src='https://cdn.ko-fi.com/cdn/kofi3.png?v=2' alt='Buy Coffee for rahuldkjain' /> </a> <a href="https://www.buymeacoffee.com/rahuldkjain" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="23" width="100" style="border-radius:1px" /> </p>

Tired of editing GitHub Profile README with new features?

This tool provides an easy way to create a GitHub profile readme with the latest add-ons such as visitors count, github stats, etc.

🚀 Demo

<a href="https://rahuldkjain.github.io/github-profile-readme-generator" target="blank"> <img src="https://img.shields.io/website?url=https%3A%2F%2Frahuldkjain.github.io%2Fgithub-profile-readme-generator&logo=github&style=flat-square" /> </a>

Try the tool: GitHub Profile README Generator

🧐 Features

Just fill in the details such as Name, Tagline, Dev Platforms Username, Current Work, Portfolio, Blog, etc. with a minimal UI.

• Uniform Dev Icons

• Uniform Social Icons

• Visitors Counter Badge

• GitHub Profile Stats Card

• GitHub Top Skills

• GitHub Streak Stats

• Dynamic Dev(.)to Blogs (GitHub Action)

• Dynamic Medium Blogs (GitHub Action)

• Dynamic Personal Blogs from RSS Feed (GitHub Action)

• Wakatime Stats contribute

• Buy Me A Coffee button

Click on Generate README to get your README in markdown. You can preview the README too.

🛠️ Installation Steps

1. Clone the repository

git clone https://github.com/rahuldkjain/github-profile-readme-generator.git

2. Change the working directory

cd github-profile-readme-generator

3. Install dependencies

npm install

4. Run the app

npm run dev

🌟 You are all set!

🍰 Contributing

Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

💻 Built with

• Next.js 15 - React framework with App Router
• TypeScript - Type safety and better DX
• Tailwind CSS - Utility-first CSS framework
• Framer Motion - Production-ready motion library
• Lucide React - Beautiful & consistent icons
• React Hook Form - Performant forms with easy validation

🙇 Special Thanks

• Anurag Hazra for amazing github-readme-stats
• Anton Komarev for super cool github-profile-views-counter
• Gautam Krishna R for the awesome blog post workflow
• Jonah Lawrence for the incredible github-readme-streak-stats
• Julien Monty for super useful devicon
• Eliot Sanford for adding hashnode as a blog input

🙇 Sponsors

• Scott C Wilson donated the first-ever grant to this tool. A big thanks to him.
• Max Schmitt loved the tool and showed support with his donation. Thanks a lot.
• Aadit Kamat find the tool useful and showed support with his donation. A big thanks to him.
• Jean-Michel Fayard used the generator to create his GitHub Profile README and he loved it. Thanks to him for showing support to the tool with the donation.

🔒 Privacy & Analytics

This tool includes privacy-friendly analytics to help improve the user experience:

• Google Analytics 4 with GDPR-compliant consent management
• IP anonymization and privacy-first configuration
• Custom events tracking for GitHub auto-fill, README generation, and exports
• Cookie consent banner - users can opt-out anytime
• No personal data collection - only anonymous usage patterns

📄 Font Licensing

This project uses the Wotfard font family:

• Font: Wotfard Regular
• Usage: This font is used under fair use for open source projects
• Source: Downloaded from online typography resources
• Note: If you're the font creator and have concerns about usage, please contact us

For commercial use of this project, please verify font licensing requirements.

🙏 Support

<p align="left"> <a href="https://www.paypal.me/rahuldkjain/10"><img src="https://ionicabizau.github.io/badges/paypal.svg" alt="sponsor github profile readme generator"/> </a> <a href="https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Frahuldkjain.github.io%2Fgithub-profile-readme-generator"> <img src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Frahuldkjain.github.io%2Fgithub-profile-readme-generator" alt="tweet github profile readme generator"/> </a> </p> <p align="left"> <a href='https://ko-fi.com/A0A81XXSX' target='_blank'><img height='23' width="100" src='https://cdn.ko-fi.com/cdn/kofi3.png?v=2' alt='Buy Coffee for rahuldkjain' /> </a> <a href="https://www.buymeacoffee.com/rahuldkjain" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="23" width="100" style="border-radius:2px" /> </p>

🌟 Star History

<picture> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=rahuldkjain/github-profile-readme-generator&type=Date&theme=dark" /> <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=rahuldkjain/github-profile-readme-generator&type=Date" /> <img alt="GPRG Star History Chart" src="https://api.star-history.com/svg?repos=rahuldkjain/github-profile-readme-generator&type=Date" /> </picture> <hr> <p align="center"> Developed with ❤️ in India 🇮🇳 </p>