GitHub Profile README Generator

A modern, interactive web application that helps you create beautiful GitHub profile README files with a live preview.

✨ Features

• Real-time Preview: See your README as you type
• Easy Form Interface: Fill out forms instead of writing markdown
• Skill Badges: Select from popular tech skills with automatic badge generation
• Project Management: Add multiple projects with descriptions and links
• Social Links: Include GitHub, LinkedIn, and Twitter profiles
• Download Functionality: Download your README as a .md file
• Responsive Design: Works on desktop and mobile devices

🚀 Live Demo

Visit the live application: GitHub Profile README Generator

🛠️ Built With

• React - Frontend framework
• Vite - Build tool and development server
• Material-UI - UI component library
• Marked - Markdown parser for preview

📦 Installation

1. Clone the repository:

git clone https://github.com/yeonkim1213/readme-generator.git
cd readme-generator

2. Install dependencies:

npm install

3. Start the development server:

npm run dev

4. Open http://localhost:3000 in your browser.

🚀 Deployment

This project is configured to deploy automatically to GitHub Pages when you push to the main branch.

Manual Deployment

1. Build the project:

npm run build

2. The built files will be in the dist folder, which you can deploy to any static hosting service.

📝 Usage

1. Fill out the form on the left side with your information
2. Watch the live preview update on the right
3. Add your skills, projects, and social links
4. Click "Download README.md" to save your file
5. Copy the content to your GitHub profile README

🤝 Contributing

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

🙏 Acknowledgments

• GitHub for the profile README feature
• Material-UI for the beautiful components
• Shields.io for the badge generation