README

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

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

🌟 Star History