Your GitHub profile is your ultimate tech resume and developer calling card. That's why having a great README.md makes a huge difference whenever someone visits your profile. To make this process as smooth and effortless as possible, I created Profile Generator, an interactive and intuitive tool designed just for this.
This project was initially built as an experiment using GitHub Spark, exploring the power of AI-assisted creation, and later refined for the community.
Step-by-Step Guide
- Access the Web App: Go to profile-generator-umber.vercel.app
- Fill In Your Information: Enter your main details, bio, social media links, and the tech stack you work with every day.
- Select Extra Components: Dynamically add personalized sections such as GitHub stats, featured projects, or custom badges.
- Generate and Copy the Code: With just one click, the tool compiles a clean, copy-paste-ready Markdown file.
How to Set It Up on Your GitHub Profile
If you don't have a profile README yet, the setup takes less than a minute:
- Create a new public repository with the EXACT same name as your GitHub username.
- Make sure to initialize it with a README.md file.
- Paste the code generated by Profile Generator into the file and commit the changes.
It's Open Source! How to Contribute
This is an open-source project, and I would love to see your ideas and contributions! Whether you want to add new components, fix styling bugs, or implement brand-new features, all contributions are highly welcome.
Official Repository:
github.com/vanessamarely/profile-generator
You can get started by leaving a star ⭐ to support the project, opening an Issue to report a bug, or sending a Pull Request directly.
Can't wait to see your profiles!
Top comments (0)