← Back to Skills Marketplace
chloepark85

Auto README Generator (ChloePark85)

by Chloe Park · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ✓ Security Clean
53
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install chloepark85-auto-readme-generator
Description
Generates a professional README.md file for a project, including name, description, installation, usage, and license sections based on project contents.
README (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

Usage Guidance
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.
Capability Analysis
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.
Capability Assessment
ℹ 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.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install chloepark85-auto-readme-generator
  3. After installation, invoke the skill by name or use /chloepark85-auto-readme-generator
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release of Auto README Generator skill by ChloePark85.
Metadata
Slug chloepark85-auto-readme-generator
Version 1.0.0
License MIT-0
All-time Installs 0
Active Installs 0
Total Versions 1
Frequently Asked Questions

What is Auto README Generator (ChloePark85)?

Generates a professional README.md file for a project, including name, description, installation, usage, and license sections based on project contents. It is an AI Agent Skill for Claude Code / OpenClaw, with 53 downloads so far.

How do I install Auto README Generator (ChloePark85)?

Run "/install chloepark85-auto-readme-generator" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is Auto README Generator (ChloePark85) free?

Yes, Auto README Generator (ChloePark85) is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does Auto README Generator (ChloePark85) support?

Auto README Generator (ChloePark85) is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created Auto README Generator (ChloePark85)?

It is built and maintained by Chloe Park (@chloepark85); the current version is v1.0.0.

More Skills
self-improving agent
Captures learnings, errors, and corrections to enable continuous improvement. Use when: (1) A command or operation fails unexpectedly, (2) User corrects Clau...
⬇ 463815 · by pskoett
Skill Vetter
Security-first skill vetting for AI agents. Use before installing any skill from ClawdHub, GitHub, or other sources. Checks for red flags, permission scope, and suspicious patterns.
⬇ 259802 · by spclaudehome
Polymarket
Query Polymarket prediction markets. Check odds, find trending markets, search events, track price movements.
⬇ 232503 · by joelchance
Self-Improving + Proactive Agent
Self-reflection + Self-criticism + Self-learning + Self-organizing memory. Agent evaluates its own work, catches mistakes, and improves permanently. Use when...
⬇ 200680 · by ivangdavila
Github
Interact with GitHub using the `gh` CLI. Use `gh issue`, `gh pr`, `gh run`, and `gh api` for issues, PRs, CI runs, and advanced queries.
⬇ 191345 · by steipete
ontology
Typed knowledge graph for structured agent memory and composable skills. Use when creating/querying entities (Person, Project, Task, Event, Document), linkin...
⬇ 190333 · by oswalpalash

💬 Comments