Creates comprehensive README files with templates for different project types. Use when creating README, project documentation, or getting started guides.
Generate a README based on project type:
# Detect project type
ls package.json && echo "Node.js project" || \
ls setup.py pyproject.toml && echo "Python project" || \
ls go.mod && echo "Go project"
Gather project information:
Choose template based on project type:
| Type | Template | Key Sections | |------|----------|--------------| | Library | library | Installation, API, Examples | | CLI Tool | cli | Installation, Commands, Options | | Web App | webapp | Features, Setup, Deployment | | API | api | Endpoints, Authentication, Examples |
Title and Description:
# Project Name
Brief one-line description of what the project does.
[](LICENSE)
[](package.json)
Installation:
## Installation
\`\`\`bash
npm install project-name
# or
pip install project-name
\`\`\`
Usage:
## Usage
\`\`\`javascript
const project = require('project-name');
// Basic example
project.doSomething();
\`\`\`
Include relevant sections:
Common badges:
For detailed information, see:
Search for places (restaurants, cafes, etc.) via Google Places API proxy on localhost.
Interact with GitHub using the `gh` CLI. Use `gh issue`, `gh pr`, `gh run`, and `gh api` for issues, PRs, CI runs, and advanced queries.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Start voice calls via the OpenClaw voice-call plugin.
Notion API for creating and managing pages, databases, and blocks.
Gemini CLI for one-shot Q&A, summaries, and generation.
Category:developer