Skylv Readme Generator

Auto-generates professional README.md from code structure, package.json, and directory analysis. Triggers: generate readme, create readme, readme from code,...

Security Scan

The skill's requested actions (listing directories, reading project manifests and source files, and composing README content) match its stated purpose and there are no unexpected installs, credentials, or persistent privileges requested.

Purpose & Capability

The name/description (generate README from codebase) align with the instructions: listing directories, detecting language-specific manifest files, parsing source to extract signatures/exports, and composing README sections are all reasonable and expected operations for this task.

Instruction Scope

The SKILL.md explicitly instructs the agent to run directory-listing commands (dir/find) and to read and parse source files for function signatures, exports, and examples. That is within scope for README generation, but it means the agent will examine repository files (which could contain secrets or sensitive data). The skill does not instruct network exfiltration, but it does ask to include 'actual code examples' which increases the risk of unintentionally including sensitive content in the generated README.

Install Mechanism

Instruction-only skill with no install spec and no code files. Nothing will be downloaded or written by an installer step.

Credentials

No environment variables, credentials, or config paths are requested. The lack of external credentials is proportional to a README generator.

Persistence & Privilege

The skill does not request always:true, does not install persistent components, and does not modify other skills or system-wide settings.

Assessment

This skill appears coherent and limited to reading the project tree and source to produce a README. Before installing/using it, be aware it will inspect repository files and may copy code snippets into the README — review the generated README before publishing to avoid leaking secrets (API keys, credentials, private endpoints). Run the skill on a copy or in a restricted environment if the repo may contain sensitive files; consider excluding directories like .env, node_modules, build artifacts, or any files with secrets. Also verify that the agent running this skill has only the filesystem access you intend (project directory only) and that you review any externally-linked badges (shields.io URLs) you do not want to expose publicly.

README Generator

Overview

Automatically analyzes a codebase and generates a comprehensive, professional README.md.

When to Use

• User asks to "generate a README", "create documentation", or "document this project"
• New project needs a README but none exists
• Existing README is outdated or incomplete

How It Works

Step 1: Analyze project structure

Run: dir /b /s /a:d (Windows) or find . -maxdepth 2 -type d (macOS/Linux)

Step 2: Detect project type

Check for: package.json (JS), setup.py/pyproject.toml (Python), Cargo.toml (Rust), go.mod (Go), pom.xml (Java)

Step 3: Generate README sections

1. Project Title - from package.json name or directory name
2. Badges - CI status, version, license, downloads
3. One-liner Description
4. Features - auto-detect from exports and main functions
5. Installation - standard install for detected type
6. Usage - realistic examples from source code
7. API Reference - parse function signatures
8. Contributing + License

Output Format

Write a complete README.md with all sections. Keep descriptions under 80 chars per line. Include real badges (shields.io) and actual code examples from the source.