Setup & Installation
openclaw skills install @fratua/readme-generator
Or with the ClawHub CLI, for registry-managed skill folders outside a full OpenClaw workspace:
npx clawhub install readme-generator
What This Skill Does
Analyzes a project's files, dependencies, and structure to produce a complete README.md. Detects the framework, package manager, license, and test setup automatically. Adapts output sections to the specific project type.
Manually writing a README requires cross-referencing package files, inferring commands, and structuring sections by hand — this skill does all of that in one pass.
When to use it
- Adding a README to a new open source repo before first publish
- Onboarding contributors to an undocumented internal tool
- Generating a README after inheriting a legacy codebase
- Documenting a CLI tool's flags and usage from source
- Refreshing an outdated README after major refactors
Example Workflow
Here's how your AI assistant might use this skill in practice.
INPUT
User asks: generate a readme for my project
AGENT
- 1Reads package.json, pyproject.toml, or other manifests to extract name, description, and dependencies
- 2Detects framework from dependency signals and config files
- 3Determines install and run commands from lockfile type and scripts
- 4Scans for license file, CI workflows, Docker config, and test directories
- 5Writes a structured README.md with only the sections relevant to the detected project type
OUTPUT
README.md written to project root with badges, install instructions, usage examples, and framework-specific sections