Khryz
🚀 Shipped it — selfreadme is now live!
Khryz
1 / 5
selfreadme
Build your GitHub profile README from a form: badges, projects, socials, a contribution snake and a views counter. No ma
README
Selfreadme
Build your GitHub profile README from a form. No markdown, no sign-in.
Selfreadme turns a few fields and clicks into a finished README.md for your GitHub profile: an introduction, tech badges, projects, certificates, social links, a contribution snake and a profile views counter. You see the result as GitHub will show it, then copy or download the file.
Features
- No markdown. Every part of the profile is a form field, a switch or a button.
- Live preview. Your README renders with GitHub's own markdown styles as you type, with a tab that shows the markdown behind it.
- Tech badges. 43 one-click presets (Python, React, Docker, Figma...) plus custom badges with any Simple Icons logo, as shields.io badges in five styles.
- Everything a profile needs. Introduction, projects, work experience, certificates and links to 15 platforms, including GitHub, LinkedIn, X, Dev.to, LeetCode and email.
- Contribution snake. An animated snake eating your contribution graph, with the GitHub Action ready to copy.
- Profile views counter. An optional badge that counts visits to your profile.
- Your layout. Turn sections on and off, rename their headings and change their order.
- Private. No account and no server: your profile is saved in your own browser.
How it works
- Open Selfreadme and fill in the editor.
- Click Download README.md (or Copy markdown).
- On GitHub, create a public repository named exactly like your username, for example
octocat/octocat, and add the file asREADME.md.
GitHub shows that file at the top of your profile. The user guide walks through every step, including the snake and the views counter.
Run it locally
You need Node.js 22.18 or newer.
git clone https://github.com/Khryz-Navarro/selfreadme.git
cd selfreadme
npm install
npm run dev
Then open the address Vite prints, usually http://localhost:5173/. The developer guide covers the scripts, the code and how deployment works.
Documentation
| Guide | For |
|---|---|
| User guide | Making and publishing your profile README, step by step |
| Developer guide | Stack, project structure, the markdown generator, testing and deployment |
| FAQ | Common questions and known limits |
| Roadmap | What's planned next |
| Contributing | How to report issues and send pull requests |
Built with
React, Vite, TypeScript, Tailwind CSS and shadcn/ui. Deployed to GitHub Pages by GitHub Actions.
Credits
- Badges by shields.io, with logos from Simple Icons.
- Profile view counts by komarev.com.
- The contribution snake is drawn by Platane/snk; the published workflow uses crazy-max/ghaction-github-pages to store it.
- README previews use github-markdown-css and marked.
- The repository includes two design skills used while building the site: taste-skill (MIT) in
.agents/and impeccable (Apache-2.0) in.claude/skills/, each with its own licence.
Selfreadme is not affiliated with GitHub.
Licence
MIT © Khryz-Navarro. The bundled design skills keep their own licences.