Animated Readme — Documentation skill for Claude Code
Write or rewrite this project's README with animated GIFs (hero, before and after, how it works) rendered from HTML.
How to install Animated Readme
Installs to ~/.claude/skills/brianarfi-animated-readme-animated-readme/SKILL.md
mkdir -p ~/.claude/skills/brianarfi-animated-readme-animated-readme && curl -fsSL https://raw.githubusercontent.com/BrianArfi/animated-readme/HEAD/commands/animated-readme.md -o ~/.claude/skills/brianarfi-animated-readme-animated-readme/SKILL.md Restart Claude Code, or start a new session, for it to be picked up.
What Animated Readme does
description: Write or rewrite this project's README with animated GIFs (hero, before and after, how it works) rendered from HTML argument-hint: "[optional: what to focus on, or 'render' to only re-render the GIFs]"
Follow the `animated-readme` skill (`.claude/skills/animated-readme/SKILL.md`).
- With no argument: run the full loop, from reading the project to showing the user the README.
- With
render: skip the writing. Runrender.py --checkandrender.pyon the existing `readm
Alternatives in Documentation
- Docs Serve — Build the HTML documentation and then serve it locally so it can be viewed in a browser 1.1k ★
- Xiaohu Wechat Format — Claude Code 公众号一键排版+发布技能 Markdown → 微信兼容 HTML → 推送草稿箱 30 套主题 + 可视化画廊 428 ★
- Wiki Build — Regenerate the static HTML site for the llmwiki 375 ★
Full documentation available on GitHub
View Source RepositoryRelated Skills
Kb Map
Build the OntoShip KB graph (gitmark map) — collapsible tree + rendered markdown + force/radial link graph as
Add Context
Enrich a handoff/plan doc with session-verified context before the next session works from it
Simplified Technical English
Write or rewrite software documentation (README, INSTALL, BUILD, CLI --help, man pages, API docs, code comment
Sdlc PR Preparation
Prepare the changelog entry and pull request for a story after Final Verification, with per-run human approval
Emile Handoff
Claude Code skill: write a session handoff doc before context runs out, so a fresh session can pick up where y
Compile Main System
You are the knowledge-base compiler for a personal markdown wiki. Use Read, Glob, and Grep to inspect existing
Related Agents
SEO Readme Writer
Use this agent to write (or rewrite) a single project's own README.md for SEO and discoverability, after the p
Brand Copywriter
Use to write or rewrite any user-facing copy — headlines, hero/section text, product and service descriptions,
Site Scribe
Use this agent to keep the AZM X website's record straight: rewrite the task list's "Right now" block before a