Readme Atelier

Designed, self-updating GitHub profile READMEs.
Six animated styles · live stats · no servers · no sign-in.

Quick start · Styles · Config · Claude · Make a theme

Readme Atelier turns your public GitHub data — stars, commits, streaks, languages, pinned repos — into a set of hand-built, animated SVG cards and a README that lays them out. A GitHub Action in your own profile repository rebuilds everything daily, so it never goes stale and never depends on someone else's server.

Easiest: use the generator at monokern.design. Pick a style, see your real profile live, then install it in one of three ways.

Template (no downloads):

1. Open readme-atelier-template → Use this template → name the repository exactly like your username, Public.
2. Edit atelier.yml (theme, tagline, links, stack) and commit.
3. The Readme Atelier workflow builds your profile in about a minute.

Existing profile repo:

npx -y github:monokernn/readme-atelier init --user <you> --theme y2k
git add . && git commit -m "add readme atelier" && git push

init writes atelier.yml and .github/workflows/readme-atelier.yml. The workflow does the rest.

Locally:

GITHUB_TOKEN=<read-only token> npx -y github:monokernn/readme-atelier build --user <you> --theme garden --preview

Writes README.md, atelier/*.svg and a preview.html. Use --demo to try styles with a fictional profile and no network.

Editorial minimal Swiss-editorial type, ruled headlines, serif italics. Light + dark.
Deep Blue y2k Y2K dreamcore: ultramarine sky, star-burst sun, chrome type, rippling waterline.
Blocky minecraft A blocky sandbox world, inventory stats, ore-block activity.
Phosphor terminal CRT terminal, scanlines, glow, typed-in name, neofetch readout.
Lofi Night pixel A pixel city at night — every building is a week of your commits.
Garden garden A floating island: repos grow into trees, contributions bloom.

Every style renders the same set of cards: header, stats, languages, activity, repo-1…4, stack, footer and one badge per link.

atelier.yml in the root of your profile repository:

username: you              # optional in the Action — defaults to the repo owner
theme: y2k                 # minimal | y2k | minecraft | terminal | pixel | garden
name: Your Name            # defaults to your GitHub name
tagline: Building small, fast things
about:                     # up to 4 short lines
  - Writing a voxel engine in Rust
  - Open to weird low-level problems
stack: [rust, typescript, neovim, linux]   # simpleicons.org slugs or names
socials:
  x: yourhandle
  github: you
  website: example.com
  linkedin: handle
  telegram: handle
  bluesky: you.bsky.social
  email: you@example.com
repos: [project-a, project-b]   # featured repos; default: pinned, then most-starred
sections: [header, socials, stats, activity, repos, stack, footer]
accent: '#ff5fc8'                # optional accent override

- uses: monokernn/readme-atelier@v1
  with:
    config: atelier.yml          # default
    token: ${{ secrets.ATELIER_TOKEN }}   # optional PAT to include private contribution counts
    commit: 'true'               # default

The workflow needs permissions: contents: write.

The generated block lives between <!-- readme-atelier:start --> and <!-- readme-atelier:end -->. Anything outside those markers is preserved. If the README has no markers the first time, it is backed up to atelier/README.backup.md.

The repository is agent-friendly: AGENTS.md explains the workflow and skills/readme-atelier/SKILL.md is a Claude Code skill. Install it as a plugin:

/plugin marketplace add monokernn/readme-atelier
/plugin install readme-atelier@readme-atelier

Then: “make my GitHub profile in the Garden style”. Claude reads your repositories, drafts the tagline and about lines, runs the generator, shows you the preview and pushes only after you approve.

• Data — GitHub GraphQL with the workflow's own GITHUB_TOKEN (public data only).
• Cards — each theme is one TypeScript file that turns a Profile into SVG strings. Animations are CSS inside the SVG, so they play on GitHub and stop for viewers with reduce motion on.
• Fonts — open-licensed fonts (SIL OFL 1.1) are embedded as WOFF2, subset per card to just the glyphs it uses.
• Icons — Simple Icons (CC0).

A theme implements eight renderers (header, stats, languages, activity, repo, stack, social, footer). See CONTRIBUTING.md — new styles are very welcome and get featured on the website.

MIT © monokern. Fonts: SIL Open Font License 1.1 — see fonts/LICENSES.md. Not affiliated with GitHub or Mojang; the Blocky style is an original pixel-art homage that uses no Mojang assets.