# Profile README

> A GitHub profile README generator at https://profile-readme.skillsafe.ai/ . Fill a short form (name, GitHub username, headline, about, now, learning, ask me about, fun fact, stack, projects, links, tone) and get a polished profile README with shields.io badges, optional stats cards, a live GitHub-style preview, copy and README.md download.

## What it does

- The template lane is free and runs entirely in the browser: the README rebuilds on every keystroke.
- Technologies typed as plain text ("Python, React, Postgres") become shields.io badges with Simple Icons logos and brand colours, grouped as Languages, Frontend, Backend, Data & ML, Databases, Cloud & DevOps, Tools.
- Profile links and an email become badges (GitHub, LinkedIn, X, Bluesky, Mastodon, YouTube, DEV, Medium, Kaggle, Hugging Face, itch.io, website, email and more).
- Projects, one per line ("name - what it does | link" or "owner/repo - what it does"), become a linked list.
- Optional GitHub stats, top-languages and streak cards, with a card theme.
- Three layouts (centered header, classic, compact), four badge styles, emoji on or off.
- Views: rendered preview, raw Markdown, per-section copy; copy all or download README.md.

## The AI writing pass (optional, paid per run)

- Rewrites only the prose: tagline, 2-4 sentence intro, About me bullets, one-line project blurbs, stack grouping, closing line, and 2-4 suggestions to make the README stronger.
- Tones: friendly, professional, playful, minimal.
- Revise with a note ("shorter", "lead with open to work").
- The page builds every link, badge and card itself; the model never writes URLs. The reply is checked in the browser against what was typed: projects and technologies that were not listed are removed, numbers that were not typed are flagged.
- Too little input returns a request for more; a request that is not a profile is declined.
- No API key needed: sign in and pay per run with SkillSafe credits. A hold is shown before the run; only what the run uses is charged.

## Free examples

Data science student, backend engineer (professional), indie game dev (playful), a revised version, a name-and-stack-only form, and a request that is not a profile. Each replays a saved, unedited reply from this app's prompt at no cost.

## API

https://profile-readme.skillsafe.ai/api.html documents the input fields (task: write or revise), the JSON output contract and examples in eight languages.

## Part of

SkillSafe - https://skillsafe.ai/