DocumentationFREEACCESS AVAILABLEFC-DOC-002
Readme Claw
readme-claw
Genera archivos README profesionales con secciones completas, badges, ejemplos de uso y estructura estándar.
Generates professional README files with proper sections, badges, installation instructions, usage examples, and contributing guidelines following community standards.
OpenClaw
Hermes
Claude Code
Codex
Cursor
Windsurf
Aider
OllamaPRIMARY ACTION
COMPATIBLE WITH
OpenClawHermesClaude CodeCodex+4
OpenClaw is the default target. Cursor example below.
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
- Secciones completas del README
- Ejemplos de código funcionales
- Estructura clara y lógica
- Instrucciones de instalación completas
- Sección de licencia incluida
5 GATES DEFINED
Expected Outputs
README.md filebadge configurationinstallation instructionsusage examplesAPI reference sectioncontributing guidelines
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 moreUse in Your Tool
Primary command uses OpenClaw by default. Secondary example targets Cursor.
OpenClaw (default)
RECOMMENDEDnpm exec --yes @flickclaw/cli@latest -- install readme-clawCursor (secondary)
npm exec --yes @flickclaw/cli@latest -- install readme-claw --target cursorSupported AI Agent Frameworks
Example Prompt
Build a complete plan and deliverable package for this agent's role in a production workflow.