← Back to Skills Marketplace
147
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install skill-readme-writer
Description
为本地项目或 GitHub 项目生成专业的 README.md 文档。**触发词:"写 README"、"生成 README"、"README.md"、"项目文档"、"GitHub 文档"、"readme"、"项目介绍"、"文档生成"**。支持自动收集项目信息、交互式确认、中英双语。根据项目类型(Python/前...
Usage Guidance
This skill appears to do what it says: it reads project files (package.json, pyproject.toml, Cargo.toml, source files, existing README) and interactively builds a README. Before installing/using it, consider: 1) It will read files under any local path you give it — avoid pointing it at directories containing secrets or unrelated private data. 2) If you supply a GitHub URL the agent may fetch repository content; ensure network fetches are acceptable in your environment. 3) The SKILL.md contains embedded Base64 image data; while likely benign for badges, base64 can conceal unexpected content — inspect any embedded blobs if you are concerned. 4) Always review the generated README and backups before committing or publishing. If the skill later requests credentials, network endpoints beyond standard badge/image URLs, or includes executable code, re-evaluate (these would raise suspicion).
Capability Analysis
Type: OpenClaw Skill
Name: skill-readme-writer
Version: 0.0.1
The skill is a utility designed to automate the creation of professional README.md files for local or GitHub projects. It follows a structured 11-step interactive workflow that includes gathering project metadata from standard configuration files (like package.json, pyproject.toml, and Cargo.toml), generating dynamic badges via shields.io, and ensuring bilingual (Chinese/English) consistency. The code and instructions in SKILL.md and README.md are well-documented, align perfectly with the stated purpose, and contain no evidence of data exfiltration, malicious execution, or prompt injection attacks. A Base64-encoded string found in the badge generation section was analyzed and confirmed to be a benign SVG logo for Windows.
Capability Assessment
Purpose & Capability
Name/description match the runtime instructions: the SKILL.md explicitly describes auto-reading package.json, pyproject.toml, Cargo.toml, main language files, directory structure and existing README to construct a README. No unrelated credentials, binaries, or installs are requested.
Instruction Scope
The instructions legitimately require reading local project files and directory structures and fetching from GitHub URLs when provided. This is expected for a README generator, but it means the agent will read arbitrary files under the supplied path (including existing README and config files). The skill states it will back up existing README before overwriting, and it requires interactive confirmation for optional sections.
Install Mechanism
Instruction-only skill with no install spec and no code files — lowest install risk. Nothing will be written to disk by an installer step beyond the normal agent runtime behavior described in SKILL.md.
Credentials
No environment variables, credentials, or config paths are requested. The set of files the skill reads (project manifests, source files, README) is proportional to its stated goal.
Persistence & Privilege
always is false and autonomous invocation is permitted (platform default). The skill does not request elevated persistence or modify other skills or global agent settings according to the provided metadata.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install skill-readme-writer - After installation, invoke the skill by name or use
/skill-readme-writer - Provide required inputs per the skill's parameter spec and get structured output
Version History
v0.0.1
README-writer 0.0.1 — 首次发布,支持自动化与交互式生成专业 README.md
- 自动收集本地/GitHub 项目结构、语言、依赖等信息,交互确认后生成专业 README.md
- 支持多种触发词,适配 Python/前端/Skill/CLI 等主流项目类型,自动识别并补全项目信息
- 交互式流程涵盖:信息确认 → 目录建议 → 可选章节(致谢/贡献/日志)→ 多轮生成与优化
- 建议 Badge 行分层生成、自动适配项目技术栈与平台,并引导用户自定义精简
- 文档风格和内容结构根据用户偏好自由选择,支持中英双语
- 设计规范化、易于迭代,适合开箱即用专业项目文档生成需求
Metadata
Frequently Asked Questions
What is skill-README-writer?
为本地项目或 GitHub 项目生成专业的 README.md 文档。**触发词:"写 README"、"生成 README"、"README.md"、"项目文档"、"GitHub 文档"、"readme"、"项目介绍"、"文档生成"**。支持自动收集项目信息、交互式确认、中英双语。根据项目类型(Python/前... It is an AI Agent Skill for Claude Code / OpenClaw, with 147 downloads so far.
How do I install skill-README-writer?
Run "/install skill-readme-writer" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is skill-README-writer free?
Yes, skill-README-writer is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does skill-README-writer support?
skill-README-writer is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created skill-README-writer?
It is built and maintained by ZeroX (@justzerox); the current version is v0.0.1.
More Skills