DocumentationPROPRO REQUIREDFC-DOC-002
Readme Claw
readme-claw
v0.2.0May 22, 2026READMEs that answer questions before they are asked — badges, installation, usage, and contribution sections that actually help
A README is not a file — it's the five-second pitch that determines whether someone installs your project or bounces to the next tab. I craft READMEs that answer "what is this, why does it exist, how do I start" in the first visible fold, with badges that actually mean something and a quickstart that works first try.
OpenClaw
Hermes
Claude Code
Codex
Cursor
Windsurf
Aider
OllamaPRIMARY ACTION
Unlock with ProCOMPATIBLE WITH
OpenClawHermesClaude CodeCodex+4
8 compatible tools3 output formats
When to Use
- Create practical README and setup docs
- Document API behavior with clarity
- Maintain reliable changelogs
- Reduce onboarding friction
Compatible Frameworks
OpenClawHermesClaude CodeCodexCursorWindsurfAiderOllama8 TOOLS
Quality Gates
- All README sections complete
- Functional code examples provided
- Clear and logical structure
- Complete installation instructions
- License section included
3 GATES DEFINED
Expected Outputs
README.md with Badge Bar, Quickstart, and Architecture DiagramProject One-Liner and Elevator PitchContributor Guide Link with Issue Templates
Native exports per tool
OpenClaw10 files
openclaw/AGENTS.mdopenclaw/SOUL.mdopenclaw/TOOLS.md+7 moreHermes5 files
hermes/skills/flickclaw/readme-claw/SKILL.mdhermes/skills/flickclaw/readme-claw/references/workflow.mdhermes/skills/flickclaw/readme-claw/references/quality-gates.md+2 moreClaude Code6 files
claude-code/CLAUDE.mdclaude-code/.claude/skills/readme-claw/SKILL.mdclaude-code/.claude/skills/readme-claw/references/workflow.md+3 moreCodex5 files
codex/AGENTS.mdcodex/.flickclaw/agents/readme-claw/codex.mdcodex/.flickclaw/agents/readme-claw/workflow.md+2 moreCursor3 files
cursor/.cursor/rules/flickclaw-readme-claw.mdccursor/.cursor/rules/flickclaw-readme-claw-workflow.mdccursor/.cursor/rules/flickclaw-readme-claw-quality-gates.mdcWindsurf3 files
windsurf/.windsurf/rules/flickclaw-readme-claw.mdwindsurf/.windsurf/rules/flickclaw-readme-claw-workflow.mdwindsurf/.windsurf/rules/flickclaw-readme-claw-quality-gates.mdAider3 files
aider/CONVENTIONS.mdaider/aider.mdaider/.aider.conf.ymlOllama4 files
ollama/Modelfileollama/system-prompt.mdollama/template.md+1 moreInstall Commands
Install the FlickClaw CLI, then select your AI agent framework below to get the correct install command.
Step 1: Install CLI (one-time)
npm install -g @flickclaw/cli@latestStep 2: Select Framework
OpenClaw
npm exec --yes @flickclaw/cli@latest -- install readme-claw --target openclawDownload as ZIP
Example Prompt
Try this prompt with Readme Claw to see what it can do:
Review the documentation and identify gaps. Generate README.md with Badge Bar, Quickstart, and Architecture Diagram, Project One-Liner and Elevator Pitch, Contributor Guide Link with Issue Templates covering setup, API reference, and troubleshooting.Example Output
IllustrativeWhat a typical Readme Claw report looks like:
# Readme Claw — Assessment Report **Project**: api-docs-site **Context**: a developer documentation site with OpenAPI specs and tutorials **Generated**: 2026-07-10 ## Executive Summary The Readme Claw completed its review of api-docs-site (a developer documentation site with OpenAPI specs and tutorials). 3 findings were identified with concrete remediation steps. All quality gates were verified before delivery. ## Findings | # | Severity | Area | Finding | Recommended Action | |---|----------|------|---------|-------------------| | 1 | **P1** | Structure | Quickstart buried 3 levels deep in navigation | Promote Quickstart to top-level with 5-minute timebox | | 2 | **P2** | Completeness | Webhook events missing from API reference | Document all webhook types with payload examples | | 3 | **P2** | Examples | Code samples lack error handling | Add try/catch blocks and error response examples | ## Quality Gates - [✓] project_purpose_and_key_differentiator_visible_in_first_viewport - [✓] quickstart_steps_tested_on_a_clean_environment - [✓] license_and_contribution_links_are_present_and_resolving ## Outputs Generated - **README.md with Badge Bar, Quickstart, and Architecture Diagram**: Included in the report above. - **Project One-Liner and Elevator Pitch**: Included in the report above. - **Contributor Guide Link with Issue Templates**: Included in the report above. ## Validation - [x] All quality gates passed (3/3) - [x] 3 findings documented with severity and remediation - [x] 3 output sections generated - [x] Evidence collected and referenced --- *This is an illustrative example output from FlickClaw. Results vary based on project context.*
RELATED AGENTS