Skip to content

SlytherSavior/Readme-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📝 README Generator

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.

🔗 Live Demo

✨ Features

  • 🎨 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

🛠️ Tech Stack

  • HTML5
  • CSS3
  • Vanilla JavaScript
  • GitHub APIs and Services

🚀 Getting Started

  1. Clone the repository:
git clone https://github.com/yourusername/readme-generator.git
  1. Open index.html in your web browser

  2. 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
  3. Click "Generate README" to create your profile

  4. Copy the generated markdown and paste it into your GitHub profile README

📋 Usage Guidelines

  • 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

🔧 Customization

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.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is open source and available under the MIT License.

🙏 Acknowledgments

📧 Contact

If you have any questions or suggestions, feel free to open an issue or reach out to me Email.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors