beauty-readmeDesign better GitHub READMEs
beauty-readme is an agent skill for GitHub documentation. It reviews your code, command output, and existing assets, then recommends a layout, rewrites the README, and creates covers, section graphics, or diagrams for GitHub.

The demo shows a project analysis, a layout recommendation, and the files it produced.
Product highlights
Start with the repository
Use the project type, code, and existing assets to decide how the documentation should be organized.
Three built-in styles
Swiss Grid organizes documentation, Terminal Neon highlights commands and output, and Editorial Poster gives the project artwork more room.
Get copy and visuals
Rewrite the Markdown and create light and dark SVG covers, or request a section graphic or diagram on its own.
Preview before publishing
Check SVG compatibility with GitHub and generate desktop and mobile previews.
What it does
Recommend a style
- Input
- An existing repository
- Output
- A layout recommendation based on the project, followed by a README preview.
Compare directions
- Input
- A project without a settled visual direction
- Output
- Three cover previews with distinct layouts.
Use a specified style
- Input
- A preferred style or existing brand guidelines
- Output
- A README or artwork that follows the chosen style.
What to ask your agent
Redesign the README
Use beauty-readme to redesign this repository’s README. Analyze the project, recommend a style, and show me a local preview.
Compare styles
Use beauty-readme to make three cover previews. Explain what each style brings out about this project.
Create only a cover
Use beauty-readme to create a light and dark cover for this project and keep the existing README copy.
Install and configure
Check out the project
You need repository access. Once you have it, clone the project and open its directory in a terminal.
git clone https://github.com/byteee-com/beauty-readme-skill.git
cd beauty-readme-skillInstall for Codex
Copy the skill into your personal Codex skills directory. The helper scripts require Python 3.9 or later.
mkdir -p ~/.codex/skills/beauty-readme
cp -R SKILL.md references scripts skeletons styles ~/.codex/skills/beauty-readme/Install for Claude Code
You can also install it in your personal Claude Code skills directory. Then open the repository you want to redesign and try one of the prompts above.
mkdir -p ~/.claude/skills/beauty-readme
cp -R SKILL.md references scripts skeletons styles ~/.claude/skills/beauty-readme/





Start with a30-minute conversation
Tell us what you're working on. We'll suggest a practical AI approach and outline a proof of concept.