← 返回 Skills 市场

Auto README Generator (ChloePark85)

Name: Auto README Generator (ChloePark85)
Author: chloepark85

作者 Chloe Park · GitHub ↗ · v1.0.0 · MIT-0

cross-platform ✓ 安全检测通过

总下载

当前安装

版本数

在 OpenClaw 中安装

/install chloepark85-auto-readme-generator

功能描述

Generates a professional README.md file for a project, including name, description, installation, usage, and license sections based on project contents.

使用说明 (SKILL.md)

README Generator Skill

Description

Generates a professional README.md for a project based on its contents, including project name, description, installation, usage, and license sections.

Usage

readme-generator [path]

Commands

`generate`

Generates a README.md file.

Arguments

--path \x3Cpath>: (Optional) Path to the project directory. Defaults to the current working directory.

Example

readme-generator generate --path ./my-project

安全使用建议

This looks safe to use for a local README draft. Before installing or running it, make sure you are in the correct project folder, back up any existing README.md, and review the generated content—especially the license—before committing or publishing it.

功能分析

Type: OpenClaw Skill Name: chloepark85-auto-readme-generator Version: 1.0.0 The skill is a straightforward utility designed to generate a boilerplate README.md file for a project. The shell script (readme-generator.sh) simply writes a hardcoded template to the specified directory and does not exhibit any signs of malicious behavior, data exfiltration, or prompt injection.

能力评估

ℹ Purpose & Capability

The capability is aligned with generating a README, but the included script appears to create a fixed template rather than analyzing project contents, so users should review generated sections such as license text.

✓ Instruction Scope

The instructions are limited to generating a README for a specified or current project path.

✓ Install Mechanism

There is no install spec, package dependency, remote download, or external setup shown; the only code artifact is a short local shell script.

ℹ Credentials

The script writes README.md into the target directory and may replace an existing README file.

✓ Persistence & Privilege

No credentials, tokens, background services, network calls, or ongoing persistence are shown; only the generated README file remains.

如何使用

确保已安装 OpenClaw（本地或 Docker 部署）
在对话框中输入安装命令：/install chloepark85-auto-readme-generator
安装完成后，直接呼叫该 Skill 的名称或使用 /chloepark85-auto-readme-generator 触发
根据 Skill 的参数说明提供必要输入，即可获得结构化输出

版本历史

v1.0.0

Initial release of Auto README Generator skill by ChloePark85.

元数据

Slug chloepark85-auto-readme-generator

版本 1.0.0

许可证 MIT-0

累计安装 0

当前安装数 0

历史版本数 1

常见问题