Project README Generator
A local-first README builder for creating polished profiles and project pages through structured templates, custom sections, reusable badges, and a live Markdown preview.
- Role
- Creator, UI/UX Designer & Frontend Developer
- Team
- Solo Dev
- Stack
- React · TypeScript · Tailwind CSS · React Markdown · Remark GFM · Rehype · React Resizable Panels
README Generator started from a simple annoyance: writing the same Markdown structure by hand every time. I wanted the freedom of a custom README without turning every edit into a formatting chore.
I designed and built it as a local-first web tool. Structured Mode guides users through reusable sections, while Advanced Mode allows direct Markdown editing whenever they want full control. Every change appears immediately in a GitHub-style preview with support for GitHub Flavored Markdown.
Users can create and reorder custom sections, arrange monochrome Shields.io badges, resize the editor and preview panels, switch themes, then copy the result or download a ready-to-use README.md file. Complete setups can also be exported as versioned JSON templates and loaded again later.
Everything is stored locally in the browser, so the tool does not require an account, database, or backend. The main challenge was making the structured editor and raw Markdown mode behave like two views of the same document while keeping imported templates safe and compatible with older saved versions.