Menu
Creates and writes professional README.md files for software projects. Use when the user asks to write a README, create documentation, or generate project docs from existing code or a description.
Performs thorough code reviews covering bugs, security vulnerabilities, performance, and style. Use when the user asks to review code, check a pull request, or audit a file for issues.
Extract text and tables from PDF files, fill PDF forms, merge and split documents. Use when the user mentions PDFs, forms, document extraction, or needs to combine multiple PDF files.
| name | readme-writer |
| description | Creates and writes professional README.md files for software projects. Use when the user asks to write a README, create documentation, or generate project docs from existing code or a description. |
| license | Apache-2.0 |
| metadata | {"author":"example-org","version":"1.0"} |
Generate a complete, professional README.md and write it to disk. The output should be clear enough for a first-time contributor to understand the project, set it up locally, and start contributing.
Look for project context before asking the user:
ls -la
cat package.json 2>/dev/null || cat pyproject.toml 2>/dev/null || cat go.mod 2>/dev/null
Every README must include:
Write the README directly to disk:
cat > README.md << 'EOF'
# Project Name
> One-line description
...content...
EOF