What is this?
It's a generator for GitHub profile READMEs: fill in a short form and it produces markdown with popular add-ons, ready to paste into your profile repo.
It's a generator for GitHub profile READMEs: fill in a short form and it produces markdown with popular add-ons, ready to paste into your profile repo.Is this something I install, or a website I just open?It's a web app — a hosted demo opens right in the browser, no install. Since the source is public, you can also run your own copy: clone the repo, install dependencies and start the Next.js app.
It's a web app — a hosted demo opens right in the browser, no install. Since the source is public, you can also run your own copy: clone the repo, install dependencies and start the Next.js app.How do I go from empty form to a finished profile README?Fill in fields like Name, Tagline, dev platform usernames, Current Work, Portfolio and Blog in the minimal UI, click Generate README, then preview the markdown before copying it to your profile repo.
Fill in fields like Name, Tagline, dev platform usernames, Current Work, Portfolio and Blog in the minimal UI, click Generate README, then preview the markdown before copying it to your profile repo.Do any of the add-ons need extra setup in my GitHub repo?The blog add-ons ship as GitHub Actions you set up in your profile repo so posts pull in automatically; stat badges are rendered by external services like github-readme-stats.
The blog add-ons ship as GitHub Actions you set up in your profile repo so posts pull in automatically; stat badges are rendered by external services like github-readme-stats.Any catches, like using it for commercial projects?The README flags font licensing: the Wotfard font is used under claimed fair use for open source, and for commercial use of the project you should verify the font licensing requirements yourself.
The README flags font licensing: the Wotfard font is used under claimed fair use for open source, and for commercial use of the project you should verify the font licensing requirements yourself.Does the site track me while I use it?It uses privacy-friendly analytics: Google Analytics 4 with GDPR-compliant consent and IP anonymization, a cookie banner with opt-out, and no personal data collection — only anonymous usage patterns.
It uses privacy-friendly analytics: Google Analytics 4 with GDPR-compliant consent and IP anonymization, a cookie banner with opt-out, and no personal data collection — only anonymous usage patterns.What add-ons can it put on my profile?Uniform dev and social icons, a visitors counter badge, a GitHub profile stats card, top skills, streak stats, WakaTime stats, a Buy Me a Coffee button, and dynamic blog lists from dev.to, Medium or any RSS feed.
Uniform dev and social icons, a visitors counter badge, a GitHub profile stats card, top skills, streak stats, WakaTime stats, a Buy Me a Coffee button, and dynamic blog lists from dev.to, Medium or any RSS feed.Why did the author build this?Hand-editing a profile README to keep up with new features gets tedious; the generator wraps the latest add-ons — visitors count, GitHub stats and more — in a simple form instead.
Hand-editing a profile README to keep up with new features gets tedious; the generator wraps the latest add-ons — visitors count, GitHub stats and more — in a simple form instead.Is it free and open source?Yes — the code is Apache-2.0 licensed, the hosted generator is free to use, and the project accepts donations through a sponsors section. It's also a hacktoberfest-friendly repo.
Yes — the code is Apache-2.0 licensed, the hosted generator is free to use, and the project accepts donations through a sponsors section. It's also a hacktoberfest-friendly repo.What is it built with?Next.js 15 with the App Router, TypeScript, Tailwind CSS, Framer Motion, Lucide React icons and React Hook Form for the form handling.
Next.js 15 with the App Router, TypeScript, Tailwind CSS, Framer Motion, Lucide React icons and React Hook Form for the form handling.What are similar projects?beautify-github-profile, metrics, gitdiagram, docs, markdown-badges, skill-icons, typebot.io, formbricks
beautify-github-profile, metrics, gitdiagram, docs, markdown-badges, skill-icons, typebot.io, formbricksWhich topics is it in?profile-readme, generator, readme, forms, icons, tailwindcss, github-actions, github, nextjs, hacktoberfest, web-app, markdown
profile-readme, generator, readme, forms, icons, tailwindcss, github-actions, github, nextjs, hacktoberfest, web-app, markdown