beautify-github-readme

An agent skill that redesigns a repository README and builds a hero, diagrams and SVG assets from the project itself

Skill

Medium risk

We rate an entry medium when the tool runs code, makes network calls or reads project files. Check what exactly it does before installing.

Why this level

  • Reads the repository and creates files
  • Runs render scripts and may connect image generation
All reasons and checks

oil-oil/beautify-github-readme

Install

In your terminal, with SkillFoxx CLI

npx skillfoxx add skills/beautify-github-readme

Detects the agents on your machine, checks the risk and pins the version.

Other ways to install

Run in a terminal in the project folder

npx skills add oil-oil/beautify-github-readme --skill beautify-github-readme -a claude-code -y

The skills tool installs the current version from the repository. Add the -g flag to use the skill in every project.

Without third-party tools, from commit d48dd84
tmp=$(mktemp -d)
git clone --filter=blob:none --no-checkout https://github.com/oil-oil/beautify-github-readme.git "$tmp"
git -C "$tmp" sparse-checkout set --no-cone /skills/beautify-github-readme/
git -C "$tmp" checkout d48dd84c98fb078cc97a06fbfa113870f433a451
mkdir -p .claude/skills
cp -R "$tmp/skills/beautify-github-readme" .claude/skills/beautify-github-readme

Commands for macOS and Linux, on Windows run them in Git Bash.

Run in a terminal in the project folder

npx skills add oil-oil/beautify-github-readme --skill beautify-github-readme -a cursor -y

The skills tool installs the current version from the repository. Add the -g flag to use the skill in every project.

Without third-party tools, from commit d48dd84
tmp=$(mktemp -d)
git clone --filter=blob:none --no-checkout https://github.com/oil-oil/beautify-github-readme.git "$tmp"
git -C "$tmp" sparse-checkout set --no-cone /skills/beautify-github-readme/
git -C "$tmp" checkout d48dd84c98fb078cc97a06fbfa113870f433a451
mkdir -p .agents/skills
cp -R "$tmp/skills/beautify-github-readme" .agents/skills/beautify-github-readme

Commands for macOS and Linux, on Windows run them in Git Bash.

Run in a terminal in the project folder

npx skills add oil-oil/beautify-github-readme --skill beautify-github-readme -a github-copilot -y

The skills tool installs the current version from the repository. Add the -g flag to use the skill in every project.

Without third-party tools, from commit d48dd84
tmp=$(mktemp -d)
git clone --filter=blob:none --no-checkout https://github.com/oil-oil/beautify-github-readme.git "$tmp"
git -C "$tmp" sparse-checkout set --no-cone /skills/beautify-github-readme/
git -C "$tmp" checkout d48dd84c98fb078cc97a06fbfa113870f433a451
mkdir -p .github/skills
cp -R "$tmp/skills/beautify-github-readme" .github/skills/beautify-github-readme

Commands for macOS and Linux, on Windows run them in Git Bash.

Run in a terminal in the project folder

npx skills add oil-oil/beautify-github-readme --skill beautify-github-readme -a codex -y

The skills tool installs the current version from the repository. Add the -g flag to use the skill in every project.

Without third-party tools, from commit d48dd84
tmp=$(mktemp -d)
git clone --filter=blob:none --no-checkout https://github.com/oil-oil/beautify-github-readme.git "$tmp"
git -C "$tmp" sparse-checkout set --no-cone /skills/beautify-github-readme/
git -C "$tmp" checkout d48dd84c98fb078cc97a06fbfa113870f433a451
mkdir -p .agents/skills
cp -R "$tmp/skills/beautify-github-readme" .agents/skills/beautify-github-readme

Commands for macOS and Linux, on Windows run them in Git Bash.

Run in a terminal in the project folder

npx skills add oil-oil/beautify-github-readme --skill beautify-github-readme -a gemini-cli -y

The skills tool installs the current version from the repository. Add the -g flag to use the skill in every project.

Without third-party tools, from commit d48dd84
tmp=$(mktemp -d)
git clone --filter=blob:none --no-checkout https://github.com/oil-oil/beautify-github-readme.git "$tmp"
git -C "$tmp" sparse-checkout set --no-cone /skills/beautify-github-readme/
git -C "$tmp" checkout d48dd84c98fb078cc97a06fbfa113870f433a451
mkdir -p .agents/skills
cp -R "$tmp/skills/beautify-github-readme" .agents/skills/beautify-github-readme

Commands for macOS and Linux, on Windows run them in Git Bash.

Run in a terminal in the project folder

tmp=$(mktemp -d)
git clone --filter=blob:none --no-checkout https://github.com/oil-oil/beautify-github-readme.git "$tmp"
git -C "$tmp" sparse-checkout set --no-cone /skills/beautify-github-readme/
git -C "$tmp" checkout d48dd84c98fb078cc97a06fbfa113870f433a451
mkdir -p .devin/skills
cp -R "$tmp/skills/beautify-github-readme" .devin/skills/beautify-github-readme

Commands for macOS and Linux, on Windows run them in Git Bash.

Formerly Windsurf.

Run in a terminal in the project folder

npx skills add oil-oil/beautify-github-readme --skill beautify-github-readme -a cline -y

The skills tool installs the current version from the repository. Add the -g flag to use the skill in every project.

Without third-party tools, from commit d48dd84
tmp=$(mktemp -d)
git clone --filter=blob:none --no-checkout https://github.com/oil-oil/beautify-github-readme.git "$tmp"
git -C "$tmp" sparse-checkout set --no-cone /skills/beautify-github-readme/
git -C "$tmp" checkout d48dd84c98fb078cc97a06fbfa113870f433a451
mkdir -p .cline/skills
cp -R "$tmp/skills/beautify-github-readme" .cline/skills/beautify-github-readme

Commands for macOS and Linux, on Windows run them in Git Bash.

Run in a terminal in the project folder

npx skills add oil-oil/beautify-github-readme --skill beautify-github-readme -a roo -y

The skills tool installs the current version from the repository. Add the -g flag to use the skill in every project.

Without third-party tools, from commit d48dd84
tmp=$(mktemp -d)
git clone --filter=blob:none --no-checkout https://github.com/oil-oil/beautify-github-readme.git "$tmp"
git -C "$tmp" sparse-checkout set --no-cone /skills/beautify-github-readme/
git -C "$tmp" checkout d48dd84c98fb078cc97a06fbfa113870f433a451
mkdir -p .roo/skills
cp -R "$tmp/skills/beautify-github-readme" .roo/skills/beautify-github-readme

Commands for macOS and Linux, on Windows run them in Git Bash.

A fork of Roo Code, same .roo folders.

Run in a terminal in the project folder

npx skills add oil-oil/beautify-github-readme --skill beautify-github-readme -a opencode -y

The skills tool installs the current version from the repository. Add the -g flag to use the skill in every project.

Without third-party tools, from commit d48dd84
tmp=$(mktemp -d)
git clone --filter=blob:none --no-checkout https://github.com/oil-oil/beautify-github-readme.git "$tmp"
git -C "$tmp" sparse-checkout set --no-cone /skills/beautify-github-readme/
git -C "$tmp" checkout d48dd84c98fb078cc97a06fbfa113870f433a451
mkdir -p .agents/skills
cp -R "$tmp/skills/beautify-github-readme" .agents/skills/beautify-github-readme

Commands for macOS and Linux, on Windows run them in Git Bash.

Run in a terminal in the project folder

tmp=$(mktemp -d)
git clone --filter=blob:none --no-checkout https://github.com/oil-oil/beautify-github-readme.git "$tmp"
git -C "$tmp" sparse-checkout set --no-cone /skills/beautify-github-readme/
git -C "$tmp" checkout d48dd84c98fb078cc97a06fbfa113870f433a451
mkdir -p .agents/skills
cp -R "$tmp/skills/beautify-github-readme" .agents/skills/beautify-github-readme

Commands for macOS and Linux, on Windows run them in Git Bash.

Run in a terminal in the project folder

tmp=$(mktemp -d)
git clone --filter=blob:none --no-checkout https://github.com/oil-oil/beautify-github-readme.git "$tmp"
git -C "$tmp" sparse-checkout set --no-cone /skills/beautify-github-readme/
git -C "$tmp" checkout d48dd84c98fb078cc97a06fbfa113870f433a451
mkdir -p .agents/skills
cp -R "$tmp/skills/beautify-github-readme" .agents/skills/beautify-github-readme

Commands for macOS and Linux, on Windows run them in Git Bash.

You will need: Node.js

Checked against the repository on Sep 25, 2026, commit d48dd84.

Text for your agent

Install the skill with npx skills add oil-oil/beautify-github-readme. Then pick whole-README mode or asset-only mode.

Other ways from the author
npx skills add oil-oil/beautify-github-readme

Adds the skill to your agent's skills directory.

This is third-party code. Review the repository files before installing.

What it does

The skill reads the repository and rebuilds the README so a visitor grasps the project's value, proof and setup at a glance. It runs in two modes: a full README pass or asset-only work such as a hero, section headers, diagrams and badges. The visual layer is deterministic SVG, with optional raster or generated imagery, and GIF motion only on an explicit opt-in. It never commits or publishes without approval and shows a local preview first.

Who it is for. For developers, designers and project owners who want a clear, well-structured README.

Good fit when

  • You want to redesign a project README around its real theme
  • You need only a hero, a diagram or a set of README SVG assets
  • You want a read-only audit of a README for clarity and order

Not a fit when

  • You want a plain text README without visual design
  • You cannot run render scripts or connect image generation

Example request

Redesign this repository README around the project theme, show a local preview first and do not publish anything

Limitations

Markdown and SVG need no keys; PNG, WebP and generated art require your own render and image tools. The skill does not invent metrics or endorsements and works from the repository's real facts. Commits, pushes and publishing always need explicit approval.

How to disable. Remove the skill folder from your agent's skills directory, for example ~/.claude/skills/beautify-github-readme.

Security check

  • Reads the repository and creates files
  • Runs render scripts and may connect image generation

README in short

The README is itself a demo: a themed hero, a style wall, real cases and SVG section transitions. The skill separates layers: SVG for visuals, Markdown for text and commands, GIF for optional motion. It ships two modes, reference guides for SVG and hero production, plus audit and render scripts. It installs via npx skills add or by asking your agent. MIT licensed.

SKILL.md

---
name: beautify-github-readme
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.
---

# 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.

FAQ

Will it push changes to my repository?

No. It prepares a preview and a diff; commits, pushes and publishing happen only after you explicitly approve.

Editors’ pick

A skill that strips AI writing tells from text using Wikipedia's list, without adding invented facts

SkillLow riskNo VPN needed52.7KRepository stars

Marketing Skills for AI agents

Marketing Skills for AI Agents

Editors’ pick

About fifty skills for CRO, copywriting, SEO, analytics, ads and launches, built for coding agents

SkillLow risk51.8KRepository stars
Official

SendPulse's official remote MCP server: statistics, campaigns and user data through an agent chat

MCP serverHigh riskRussian stack1Repository stars
Editors’ pick

An MCP server and CLI covering all 113 Yandex Direct API v5 methods generated from WSDL, exposing 9 read tools by default and writes only on demand

MCP serverHigh riskRussian stackNo VPN needed1Repository stars
Foxx AIbeautify-github-readme

I am Foxx AI and I have already vetted this tool. Ask about install, setup or anything else, and I will keep it simple.