# Beautify Github Readme

Redesign GitHub README homepages or create project-native pure SVG, hybrid SVG-composed...

- Repository: https://github.com/oil-oil/beautify-github-readme (1934 stars)
- Category: Git and review
- License: MIT
- Last updated: 2026-10-04
- Runs scripts: yes, review before use

## Install

Claude Code: `npx skills add oil-oil/beautify-github-readme --skill beautify-github-readme -g -a claude-code -y`
Codex: `npx skills add oil-oil/beautify-github-readme --skill beautify-github-readme -g -a codex -y`
Cursor: `npx skills add oil-oil/beautify-github-readme --skill beautify-github-readme -g -a cursor -y`
Gemini CLI: `npx skills add oil-oil/beautify-github-readme --skill beautify-github-readme -g -a gemini-cli -y`

## Description

Redesign GitHub README homepages or create project-native pure SVG, hybrid SVG-composed PNG/WebP, and opt-in animated GIF assets. Use when a user asks to beautify, redesign, rebrand, visually upgrade, simplify, or audit a GitHub README; create only a hero, section headers, diagrams, badges, motion graphics, showcase modules, or other README assets; or turn a repository homepage into a cohesive visual story. If whole-README work versus asset-only work is unclear, ask which scope the user wants. For hero-like assets where pure SVG and generated raster material are both viable, explain the tradeoffs and confirm the implementation before creating the asset.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# Beautify GitHub README

Turn a repository homepage or requested visual asset into a concise, theme-specific visual story. Treat Markdown as the content layer, deterministic SVG as the layout system, and generated raster material as an optional visual ingredient.

## Workflow

### 1. Confirm the mode before editing

Use exactly one execution mode:

- **README mode**, improve the whole README: information order, copy hierarchy, proof, Markdown, and visual system.
- **Asset-only mode**, create only the requested static SVG or visual asset set. Static SVG is the default. Only after the user explicitly opts into meaningful motion, optionally deliver a GitHub-safe GIF while keeping the SVG as the editable fallback. Do not rewrite, reorder, or embed anything in the README unless the user explicitly adds that scope.

If the mode is not explicit, ask one compact question before making changes:

> Would you like me to improve the whole README or only create visual assets? If asset-only, tell me whether you need a hero, section headers, workflow, badge, motion graphic, or a coordinated set.

When a hero, badge, workflow, or diagram has meaningful motion and the user has not specified static or animated output, ask one compact follow-up:

> Should this stay as a static SVG, or would you like a GitHub-safe GIF animation with the SVG kept as the editable fallback?

GIF is opt-in and never the default. If the user declines, does not answer, or has no meaningful motion case, continue with static SVG only. Do not ask when motion would be purely decorative or the user already chose the output. Read-only inspection is allowed before the answer when it helps understand the repository. Do not interpret “use this Skill,” a repository path, or “beautify it” as permission to modify the whole README. Once the user chooses asset-only mode, expanding into README edits requires new authorization.

The rest: https://github.com/oil-oil/beautify-github-readme/blob/HEAD/skills/beautify-github-readme/SKILL.md