📝 Readme
This skill creates absurdly thorough README documentation for a project, covering setup, architecture, deployment, and maintenance to save you time.
npx playbooks add skill sickn33/antigravity-awesome-skills --skill readme
About Readme
This skill creates absurdly thorough README documentation for a project, covering setup, architecture, deployment, and maintenance to save you time.
This compact 20-word instruction set is purpose-built for documentation work in AI coding agents. Install with a single command.
Use Cases
- Writing API references and README files
- Generating inline code comments and docstrings
- Creating architecture decision records (ADRs)
- Keeping docs in sync with code changes
Example Prompts
System Prompt (20 words)
This skill creates absurdly thorough README documentation for a project, covering setup, architecture, deployment, and maintenance to save you time.
Frequently Asked Questions
What is Readme?
Readme is a free documentation skill for AI coding agents. This skill creates absurdly thorough README documentation for a project, covering setup, architecture, deployment, and maintenance to save you time.. It provides a specialized system prompt that configures your agent with documentation expertise.
How do I use Readme with Claude Code?
Run npx playbooks add skill sickn33/antigravity-awesome-skills --skill readme in your terminal to install Readme into your Claude Code session. It works immediately after installation.
Which AI coding agents work with Readme?
Readme is compatible with Claude Code, Cursor, GitHub Copilot, Windsurf, OpenClaw, Cline, and any AI agent that supports custom system prompts or .cursorrules files.
Is Readme free to use?
Yes, Readme is completely free and open source. The full source is available on GitHub at https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/readme. You only need a subscription to the AI agent you use it with.
