Readme Gen
当用户想写 README、生成项目文档、补充项目说明时使用 — 自动从代码中提取生成专业 README
Install
$ agentstack add skill-lightpointventures-claude-code-starter-readme-gen ✓ scanned · ✓ verified, works with Claude Code, Cursor, and more.
Security review
✓ PassedNo issues found. Passed automated security review. · v0.1.0 How review works →
- ✓ Prompt-injection patterns
- ✓ Secret / credential exfiltration
- ✓ Dangerous shell & filesystem operations
- ✓ Untrusted network calls
- ✓ Known-malicious package signatures
What it can access
- ✓ Network access No
- ✓ Filesystem access No
- ✓ Shell / process execution No
- ✓ Environment & secrets No
- ✓ Dynamic code execution No
From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.
Verified badge
Passed review? Show it. Paste this badge into your README, it links to the public security report.
Links to your public security report.[](https://agentstack.voostack.com/security/report/skill-lightpointventures-claude-code-starter-readme-gen) Reliability & compatibility
Declared compatibility
Compatibility is declared by the source manifest. End-to-end runtime verification is coming, see below.
We're building live execution health for every listing: tool-call success rate, median latency, uptime, and last-checked timestamps, measured, not self-reported. It isn't live yet, so we don't show numbers we can't stand behind.
How agent discovery & health will work →About
生成 README
帮用户为项目自动生成一份专业的 README 文档。
步骤
1. 分析项目
自动读取项目中的关键文件：
- package.json / pyproject.toml / go.mod → 项目名、描述、依赖
- 项目目录结构 → 了解项目组成
- CLAUDE.md → 项目描述和技术栈信息
- 已有 README → 保留有价值的内容
2. 提问补充
> 有几个信息需要确认： > 1. 一句话描述这个项目（如果还没有的话） > 2. 项目目前是什么状态？（开发中 / 可用 / 稳定） > 3. README 用中文还是英文？
3. 生成 README
生成包含以下部分的 README.md：
- 项目标题和描述 — 简洁有力的一句话
- 功能特性 — 项目核心功能的要点列表
- 快速开始 — 安装和运行的最少步骤
- 使用方法 — 基本用法和示例
- 技术栈 — 使用的主要技术
- 项目结构 — 关键目录和文件说明（简洁版）
- 开发指南 — 如何参与开发（如果需要）
- License — 许可证信息
规则：
- 内容从项目实际代码中提取，不要编造功能
- 安装步骤要准确可执行
- 保持简洁，不要把 README 写成文档站
4. 确认
展示生成的内容，用户确认后写入。
Source & license
This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.
- Author: lightpointventures
- Source: lightpointventures/claude-code-starter
- License: MIT
- Homepage: https://github.com/lighthouse-strategy/claude-code-starter
Install and usage instructions live in the source repository linked above.
Reviews
No reviews yet, be the first.
Write a review
Versions
- v0.1.0 Imported from the upstream source.