An intelligent documentation agent that scans your codebase to generate professional, multi-language README files with dynamic badges.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install skill-readme-writer
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install skill-readme-writer using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is README Writer?
README Writer is a specialized tool within the Openclaw Skills library designed to automate the creation of high-quality project documentation. By performing a deep analysis of local directories or GitHub repositories, it automatically identifies the project name, version, dependencies, and core functionality. It is particularly useful for developers who want to maintain professional standards across their repositories without spending hours writing manual documentation.
The skill follows an interactive workflow, ensuring that the generated content accurately reflects the project's purpose while allowing for user customization. It supports various tech stacks including Python, Node.js, Rust, and Go, making it a versatile choice for any developer using Openclaw Skills to streamline their workflow.
README Writer Use Cases
- Automatically generating a professional README for a new GitHub repository.
- Creating bilingual (English and Chinese) documentation for open-source projects to reach a wider audience.
- Updating legacy projects with modern SVG badges for platforms, licenses, and tech stacks.
- Standardizing documentation structure across multiple internal team projects.
How README Writer Works
- The user triggers the skill by providing a project path or a GitHub URL.
- The agent scans configuration files like package.json, requirements.txt, or Cargo.toml to extract project metadata.
- A summary of the detected information is presented to the user for verification.
- The agent prompts the user for specific documentation preferences, such as target audience and visual style.
- A proposed table of contents is generated and refined based on user feedback.
- The final README.md is produced, featuring dynamic shields.io badges and complete usage examples.
- A backup of any existing documentation is created before the new file is saved.
README Writer Setup
To use this skill within your Openclaw Skills environment, ensure you have the project directory accessible or a valid Git URL. Use the following command in your terminal or agent interface:
# Trigger documentation for a local project
write README for path/to/your/project
# Trigger documentation for a remote repository
generate README for https://github.com/user/repo
README Writer Data Schema & Taxonomy
The skill organizes data based on the project type and user-selected detail level. It utilizes the following structure for output:
| Component | Source/Detection | Format |
|---|---|---|
| Core Info | package.json, pyproject.toml | Markdown Header |
| Tech Stack | dependencies scanning | Dynamic Shields.io Badges |
| Installation | scripts and requirements | Bash Code Blocks |
| Usage | Main file analysis (.py, .js, .ts) | Code Snippets |
| License | LICENSE file or metadata | License Badge |
README Writer Advanced Features
- Multi-language Support: Generates synchronized English and Chinese versions with independent Tables of Contents.
- Dynamic Badge Generation: Automatically creates multi-row badges for CI/CD status, platform compatibility (Windows, macOS, Linux), and package registries.
- Interactive Section Management: Users can toggle optional sections like Acknowledgements, Contributing Guidelines, and Changelogs.
- Versioned Backups: Automatically executes a copy command to save previous README versions with timestamps before overwriting.
SKILL.md
Loading
Related Openclaw Skills
News Summary Bot
An automated news aggregation tool that scrapes top Vietnamese news sources and delivers summarized reports with direct links to a Telegram Channel.
MVP Kanban Board Skill
A comprehensive Kanban management system featuring AI-driven bottleneck analysis, vector search, and seamless MCP integration for automated workflows.
SecLists Pattern-Matching
A comprehensive collection of regex-ready patterns for detecting sensitive data like API keys, credit cards, and PII during security audits.
Reddit Marketing Strategist
A specialized strategy agent designed to help founders and developers promote products on Reddit through authentic, community-first engagement.
UrlBae
A professional integration for AI agents to automate URL shortening, link bundling, and link management workflows.
WeChat Article Reader
A specialized extraction tool for Openclaw Skills designed to reliably read and parse content from WeChat Official Account articles.
Featured*
