A modern, user-friendly web application that helps developers create beautiful and professional GitHub README profiles with ease. Built with vanilla JavaScript and a clean, intuitive interface.
- 🎨 Beautiful and responsive UI
- 📝 Easy-to-use form interface
- 🚀 Dynamic GitHub stats integration
- 🎯 Animated typing text support
- 💻 Tech stack visualization
- 📊 GitHub activity graphs
- 🏆 GitHub trophies display
- 🔗 Social media integration
- 📱 Mobile-friendly design
- HTML5
- CSS3
- Vanilla JavaScript
- GitHub APIs and Services
- Clone the repository:
git clone https://github.com/yourusername/readme-generator.git-
Open
index.htmlin your web browser -
Fill in your details in the form:
- GitHub username
- Animated text (use semicolons for line breaks)
- About me section
- Tech stack (comma-separated)
- Project details
- Social links
-
Click "Generate README" to create your profile
-
Copy the generated markdown and paste it into your GitHub profile README
- Use semicolons (
;) to create line breaks in animated text - Use
**text**for bold text in descriptions - Separate tech stack items with commas
- Use lowercase for technology names
- Ensure correct spelling of technology names
The generator uses various GitHub services and APIs:
- GitHub Readme Typing SVG
- GitHub Profile Trophy
- GitHub Readme Stats
- GitHub Activity Graph
- Skill Icons
You can customize the appearance by modifying the theme parameters in the API URLs.
Contributions are welcome! Please feel free to submit a Pull Request.
This project is open source and available under the MIT License.
- GitHub Readme Typing SVG
- GitHub Profile Trophy
- GitHub Readme Stats
- Skill Icons
- GitHub Activity Graph
If you have any questions or suggestions, feel free to open an issue or reach out to me Email.