← Back to Skills Marketplace
246
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install readme-writer-skill
Description
Expert README writing skill for open source projects. Use this skill whenever the user wants to write, improve, or review a README for any open source reposi...
Usage Guidance
This skill appears coherent and low-risk because it's instruction-only and doesn't ask for credentials or install code. Before using it: (1) don't paste secrets or private tokens into prompts or READMEs you generate; (2) treat any example 'install' commands (notably 'curl | sh') as documentation examples only — verify the source before running them; (3) if you want the skill to analyze a repository, prefer providing a sanitized excerpt or grant minimal, explicit repository access rather than pasting entire config files; (4) if provenance matters, ask the publisher for source/homepage or request an auditable code-based implementation rather than an instruction-only skill.
Capability Analysis
Type: OpenClaw Skill
Name: readme-writer-skill
Version: 1.0.0
The 'readme-writer-skill' is a well-structured tool designed to assist an AI agent in generating high-quality documentation for open-source projects. The bundle consists of a main instruction file (SKILL.md) and several reference documents (references/ai-ml.md, references/frameworks.md, references/tools.md) that provide templates and best practices based on popular GitHub repositories. There is no evidence of malicious intent, data exfiltration, or harmful prompt injection; the content is purely instructional and focused on its stated purpose of README generation.
Capability Assessment
Purpose & Capability
Name/description (README writer) align with the provided assets: a SKILL.md plus three large references about README patterns for tools, AI/ML, and frameworks. There are no unexpected env vars, binaries, or install steps requested that would be unrelated to writing READMEs.
Instruction Scope
The SKILL.md describes how the agent should collect project information (ask the user or infer name, purpose, tech stack) and how to construct README content; it does not instruct the agent to read arbitrary host files, to access credentials, or to transmit repository contents to third parties. Note: the guidance contains example installation patterns (including 'curl -fsSL https://get.example.com | sh') and other sample commands which are presented as common README content — these are potentially unsafe patterns if executed by a user without verification, but they do not make the skill itself perform those actions.
Install Mechanism
There is no install spec and no code files that run on the host — this is instruction-only, which minimizes the risk of writing or executing new code on the machine.
Credentials
The skill declares no required environment variables, no primary credential, and no config paths; this is proportionate for a documentation/authoring skill.
Persistence & Privilege
always is false and model invocation is allowed (default). The skill does not request or modify other skills or system-wide settings; nothing here indicates elevated or persistent privileges.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install readme-writer-skill - After installation, invoke the skill by name or use
/readme-writer-skill - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
- Initial release of the readme-writer skill.
- Provides expert guidance and templates for writing, improving, or reviewing READMEs for open source projects.
- Covers best practices and proven structures based on patterns from 20 high-star GitHub repositories, including tools, AI/ML projects, and code frameworks.
- Includes a comprehensive universal README structure and type-specific reference guides.
- Designed to help users create clear, compelling, and user-friendly project documentation.
Metadata
Frequently Asked Questions
What is readme-writer-skill?
Expert README writing skill for open source projects. Use this skill whenever the user wants to write, improve, or review a README for any open source reposi... It is an AI Agent Skill for Claude Code / OpenClaw, with 246 downloads so far.
How do I install readme-writer-skill?
Run "/install readme-writer-skill" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is readme-writer-skill free?
Yes, readme-writer-skill is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does readme-writer-skill support?
readme-writer-skill is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created readme-writer-skill?
It is built and maintained by caopulan (@caopulan); the current version is v1.0.0.
More Skills