Skip to content

Commit e4aea56

Browse files
Ashish KumarAshish Kumar
authored andcommitted
chore: updated readme
1 parent edd4145 commit e4aea56

File tree

1 file changed

+64
-50
lines changed

1 file changed

+64
-50
lines changed

README.md

Lines changed: 64 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,112 @@
1-
# GitHub Profile README Builder 🚀
1+
# 🚀 GitHub Profile README Builder
22

33
[![GitHub stars](https://img.shields.io/github/stars/dev-ashishk/github-profile-builder)](https://github.com/dev-ashishk/github-profile-builder/stargazers)
44
[![GitHub forks](https://img.shields.io/github/forks/dev-ashishk/github-profile-builder)](https://github.com/dev-ashishk/github-profile-builder/network)
55
[![GitHub issues](https://img.shields.io/github/issues/dev-ashishk/github-profile-builder)](https://github.com/dev-ashishk/github-profile-builder/issues)
66
[![GitHub license](https://img.shields.io/github/license/dev-ashishk/github-profile-builder)](https://github.com/dev-ashishk/github-profile-builder/blob/main/LICENSE)
7-
[![Vercel deployment](https://img.shields.io/badge/vercel-deployed-brightgreen.svg)](https://github-profile-builder-dev-ashishk.vercel.app)
87

9-
Create beautiful, customizable GitHub profile READMEs with ease. No coding required!
8+
9+
Craft a stunning GitHub profile in minutes—no coding needed!
10+
Our builder helps you design your profile README effortlessly with beautiful templates and powerful integrations.
1011

1112
![GitHub Profile Builder Preview](public/github-profile-builder-preview.png)
1213

13-
## ✨ Features
14+
---
15+
16+
## ✨ What You Get
17+
18+
- **6 Unique Templates** – Choose a look that suits your vibe: Modern, Minimal, Creative, Developer, Professional, or Elegant.
19+
- **Live Preview** – Instantly see what your profile will look like while editing.
20+
- **GitHub Integration** – Just enter your username, and we’ll pull in your stats, contributions, and top repos.
21+
- **Fully Customizable Sections** – Add or remove sections like skills, projects, education, and work experience.
22+
- **Color Customization** – Match your personal branding with color theme options.
23+
- **GitHub Stats** – Automatically show off your GitHub metrics, top languages, and contribution streak.
24+
- **Trophy Display** – Highlight your GitHub achievements with stylish trophy cards.
25+
- **Contribution Graph** – Visualize your activity in style with themed graphs.
26+
- **One-click Markdown Copy** – Grab your final README with a single click.
27+
- **Dark Mode Friendly** – Switch between light and dark modes as you prefer.
28+
- **Fully Responsive** – Works seamlessly on desktops, tablets, and phones.
1429

15-
- **Multiple Templates**: Choose from 6 professionally designed templates (Modern, Minimal, Creative, Developer, Professional, and Elegant)
16-
- **Real-time Preview**: See your changes instantly with a live markdown preview
17-
- **GitHub Integration**: Automatically fetch your GitHub stats, repositories, and contribution data
18-
- **Customizable Sections**: Add/remove sections like skills, projects, experience, education, and more
19-
- **Color Themes**: Personalize your profile with custom color schemes
20-
- **GitHub Stats**: Display your GitHub statistics, top languages, and contribution streak
21-
- **Contribution Graph**: Show your GitHub contribution activity with customizable themes
22-
- **Achievement Trophies**: Showcase your GitHub achievements with customizable trophy displays
23-
- **One-click Copy**: Copy the generated markdown with a single click
24-
- **Dark Mode Support**: Switch between light and dark themes for comfortable editing
25-
- **Responsive Design**: Works on desktop, tablet, and mobile devices
30+
---
2631

2732
## 🚀 Getting Started
2833

29-
### Online Builder
34+
### Use the Online Tool
3035

31-
The easiest way to use GitHub Profile Builder is through our online tool:
36+
No need to install anything—just head to the web app and start building:
3237

33-
👉 [Open GitHub Profile Builder](https://dev-ashishk.github.io/github-profile-builder/)
38+
👉 [Launch GitHub Profile Builder](https://dev-ashishk.github.io/github-profile-builder/)
3439

35-
### Local Development
40+
### Want to Run It Locally?
3641

37-
To run the project locally:
42+
If you’d like to clone and develop locally, here’s how:
3843

3944
\`\`\`bash
40-
# Clone the repository
45+
# Clone the repo
4146
git clone https://github.com/dev-ashishk/github-profile-builder.git
4247

43-
# Navigate to the project directory
48+
# Go into the folder
4449
cd github-profile-builder
4550

46-
# Install dependencies
51+
# Install the dependencies
4752
npm install
4853

49-
# Start the development server
54+
# Start the dev server
5055
npm run dev
5156
\`\`\`
5257

53-
Open [http://localhost:3000](http://localhost:3000) in your browser to see the application.
58+
Open your browser and go to [http://localhost:3000](http://localhost:3000)
59+
60+
---
61+
62+
## 📝 How It Works
5463

55-
## 📝 How to Use
64+
1. Fill in your name, title, and bio.
65+
2. Add your GitHub username—we'll fetch your stats automatically.
66+
3. Customize sections like skills, work, education, and more.
67+
4. Pick your favorite template.
68+
5. Tweak the color theme to match your style.
69+
6. Preview your README live.
70+
7. Copy the markdown and paste it into your GitHub profile’s \`README.md\`.
5671

57-
1. **Enter Your Information**: Fill in your name, title, bio, and other details
58-
2. **Connect GitHub**: Enter your GitHub username to automatically fetch your stats
59-
3. **Customize Sections**: Add skills, projects, work experience, and more
60-
4. **Choose a Template**: Select from 6 beautiful templates
61-
5. **Personalize Colors**: Customize the color scheme to match your style
62-
6. **Preview & Copy**: Preview your profile and copy the generated markdown
63-
7. **Paste into GitHub**: Create a repository named after your GitHub username and paste the markdown into the README.md file
72+
---
6473

65-
## 🛠️ Technologies Used
74+
## 🛠 Built With
6675

67-
- [Next.js](https://nextjs.org/) - React framework
68-
- [React](https://reactjs.org/) - UI library
69-
- [Tailwind CSS](https://tailwindcss.com/) - Utility-first CSS framework
70-
- [shadcn/ui](https://ui.shadcn.com/) - UI component library
76+
- [Next.js](https://nextjs.org/) React-powered web framework
77+
- [React](https://reactjs.org/) – Frontend UI library
78+
- [Tailwind CSS](https://tailwindcss.com/) Utility-first styling
79+
- [shadcn/ui](https://ui.shadcn.com/) – Modern UI components
7180

81+
---
7282

73-
## 🤝 Contributing
83+
## 🤝 Want to Contribute?
7484

75-
Contributions are welcome! Please feel free to submit a Pull Request.
85+
Awesome! Contributions are always welcome 🙌
7686

77-
1. Fork the repository
78-
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
79-
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
80-
4. Push to the branch (`git push origin feature/amazing-feature`)
87+
1. Fork this repo
88+
2. Create a branch (\`git checkout -b feature/cool-feature\`)
89+
3. Commit your work (\`git commit -m 'Add cool feature'\`)
90+
4. Push the branch (\`git push origin feature/cool-feature\`)
8191
5. Open a Pull Request
8292

93+
---
94+
8395
## 📄 License
8496

85-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
97+
This project is open-sourced under the MIT License. See the [LICENSE](LICENSE) file for full details.
8698

87-
## 🙏 Acknowledgements
99+
---
100+
101+
## 🙏 Special Thanks
102+
103+
Big thanks to these awesome projects:
88104

89105
- [GitHub README Stats](https://github.com/anuraghazra/github-readme-stats)
90106
- [GitHub Streak Stats](https://github.com/DenverCoder1/github-readme-streak-stats)
91107
- [GitHub Profile Trophy](https://github.com/ryo-ma/github-profile-trophy)
92-
- [GitHub Contribution Chart Generator](https://github.com/sallar/github-contributions-chart)
108+
- [Contribution Chart Generator](https://github.com/sallar/github-contributions-chart)
93109

94110
---
95111

96-
Made with ❤️ by [dev-ashishk](https://github.com/dev-ashishk)
97-
98-
Keywords: GitHub profile, README generator, GitHub README, profile builder, GitHub stats, GitHub contribution graph, GitHub trophy, markdown generator, developer profile
112+
Made with ❤️ by [dev-ashishk](https://github.com/dev-ashishk)

0 commit comments

Comments
 (0)