# Beautify GitHub README

> Your agent reads the repo, reorders the README around value and proof, and designs project-native SVG heroes, diagrams and badges.

Beautify GitHub README is an Agent Skill from oil-oil that redesigns a repository's README so visitors understand the project at first glance. It reads the real repository first, finds the clearest value and proof, then decides how the page should look, with a visual direction drawn from the project itself rather than one house template.

What it does
- Confirms the scope first: a whole README, or only assets such as a hero, section headers, diagrams, badges or showcase modules
- Reorders content: cuts repetition, moves proof forward and swaps internal jargon for concrete outcomes
- Derives colour, typography, composition and motifs from the project
- Builds editable, GitHub-safe SVG heroes, section transitions, comparisons and diagrams, keeping readable text in Markdown
- Offers hybrid heroes that combine SVG layout with a generated image, and opt-in animated GIFs
- Audits the README with a bundled script and checks that images are accessible and commands copyable

How to install it
Run npx skills add oil-oil/beautify-github-readme. It works in Claude, ChatGPT, Gemini and more agents that support Agent Skills.

Good to know
- Hybrid heroes need an image-generation skill in your agent; pure SVG needs nothing extra.
- It offers a small "README made with" credit only after you're happy with the result, and never adds one, opens a PR or pushes without your explicit go-ahead.
- MIT licensed.

- Type: Skill
- Made by: oil-oil
- Category: Writing
- Formats: Skills
- Version: 3bc1430
- Website: https://github.com/oil-oil/beautify-github-readme
- Source: https://github.com/oil-oil/beautify-github-readme/tree/HEAD/skills/beautify-github-readme
- Page: https://pluginboard.ai/skills/beautify-github-readme

## Works with

- ChatGPT
- Claude
- Gemini
- GitHub Copilot
- Cursor
- Claude Code
- Codex
- Antigravity
- Gemini CLI
- Replit
- OpenClaw
- OpenCode
- Hermes Agent

## Install

### ChatGPT

In ChatGPT: Download the beautify-github-readme folder and zip it, then Plugins → Skills → Create → Upload from your computer. Business and Enterprise plans.

View the folder on GitHub: https://github.com/oil-oil/beautify-github-readme/tree/HEAD/skills/beautify-github-readme

### Claude

In Claude (web or desktop): Download the beautify-github-readme folder and zip the folder itself, then upload it in Customize → Skills.

View the folder on GitHub: https://github.com/oil-oil/beautify-github-readme/tree/HEAD/skills/beautify-github-readme

### Gemini

In Gemini: Download the beautify-github-readme folder, then at gemini.google.com click Customize → Skills → Create → Upload and pick the folder (or a .zip of it).

View the folder on GitHub: https://github.com/oil-oil/beautify-github-readme/tree/HEAD/skills/beautify-github-readme

### GitHub Copilot

Run in your terminal:

```shell
npx -y degit oil-oil/beautify-github-readme/skills/beautify-github-readme ~/.copilot/skills/beautify-github-readme
```

View the folder on GitHub: https://github.com/oil-oil/beautify-github-readme/tree/HEAD/skills/beautify-github-readme

### Cursor

Run in your terminal:

```shell
npx -y degit oil-oil/beautify-github-readme/skills/beautify-github-readme ~/.cursor/skills/beautify-github-readme
```

View the folder on GitHub: https://github.com/oil-oil/beautify-github-readme/tree/HEAD/skills/beautify-github-readme

### Claude Code

Run in your terminal:

```shell
npx -y degit oil-oil/beautify-github-readme/skills/beautify-github-readme ~/.claude/skills/beautify-github-readme
```

View the folder on GitHub: https://github.com/oil-oil/beautify-github-readme/tree/HEAD/skills/beautify-github-readme

### Codex

Run in your terminal:

```shell
npx -y degit oil-oil/beautify-github-readme/skills/beautify-github-readme ~/.agents/skills/beautify-github-readme
```

View the folder on GitHub: https://github.com/oil-oil/beautify-github-readme/tree/HEAD/skills/beautify-github-readme

### Antigravity

In Antigravity: Copy the beautify-github-readme folder into ~/.gemini/config/skills (Antigravity app and IDE) or ~/.gemini/antigravity-cli/skills (Antigravity CLI).

View the folder on GitHub: https://github.com/oil-oil/beautify-github-readme/tree/HEAD/skills/beautify-github-readme

### Gemini CLI

Run in your terminal:

```shell
npx -y degit oil-oil/beautify-github-readme/skills/beautify-github-readme ~/.gemini/skills/beautify-github-readme
```

View the folder on GitHub: https://github.com/oil-oil/beautify-github-readme/tree/HEAD/skills/beautify-github-readme

### Replit

Run in your terminal:

```shell
npx -y degit oil-oil/beautify-github-readme/skills/beautify-github-readme .agents/skills/beautify-github-readme
```

View the folder on GitHub: https://github.com/oil-oil/beautify-github-readme/tree/HEAD/skills/beautify-github-readme

### OpenClaw

Run in your terminal:

```shell
npx -y degit oil-oil/beautify-github-readme/skills/beautify-github-readme ~/.openclaw/skills/beautify-github-readme
```

View the folder on GitHub: https://github.com/oil-oil/beautify-github-readme/tree/HEAD/skills/beautify-github-readme

### OpenCode

Run in your terminal:

```shell
npx -y degit oil-oil/beautify-github-readme/skills/beautify-github-readme ~/.config/opencode/skills/beautify-github-readme
```

View the folder on GitHub: https://github.com/oil-oil/beautify-github-readme/tree/HEAD/skills/beautify-github-readme

### Hermes Agent

Run in your terminal:

```shell
npx -y degit oil-oil/beautify-github-readme/skills/beautify-github-readme ~/.hermes/skills/beautify-github-readme
```

View the folder on GitHub: https://github.com/oil-oil/beautify-github-readme/tree/HEAD/skills/beautify-github-readme

---
From Pluginboard (https://pluginboard.ai).
