Setup & Installation
Or with the ClawHub CLI, for registry-managed skill folders outside a full OpenClaw workspace:
What This Skill Does
Analyzes a GitHub repository and generates a README covering installation, usage, API documentation, and code examples. It reads package.json, requirements.txt, code comments, and function signatures to produce structured output. The result is a draft ready for review, not a final published document.
Extracting installation steps, API docs, and usage examples from code directly saves the manual work of cross-referencing multiple files to write them by hand.
When to use it
- Documenting a new open-source project before its first release
- Generating a README for a repo that has none
- Refreshing outdated documentation by re-analyzing current code
- Bootstrapping API docs from existing function signatures
- Creating installation instructions for multi-language projects
Example Workflow
Here's how your AI assistant might use this skill in practice.
User asks: Generate a README for https://github.com/user/my-project
- 1Fetch repository structure and file tree via GitHub API
- 2Parse package.json and requirements.txt for dependencies and scripts
- 3Scan code comments and function signatures to extract API documentation
- 4Select matching README template based on project type and language
- 5Validate the generated README for required sections and completeness
A markdown README file with installation steps, usage examples, and API reference sections populated from the repository contents
Requirements
Accounts, API keys, or tools you or your AI assistant may need to set up while using this skill.