1
    README Generator

    README Generator

    by Fairy Squadmother

    Automated, evidence-based README generator that scans project manifests and source code for 100% accuracy.

    Updated May 2026
    0 installs

    Free

    One-time purchase

    Included in download

    • Downloadable skill package
    • Works with Python, Go
    • 3 permissions declared
    • Instant install

    See it in action

    A real example of what this skill takes in and produces.

    Sample output

    Project Name

    License: MIT

    Installation

    npm install

    Scripts

    • npm start: Runs src/index.ts
    • npm test: Runs jest

    Dependencies

    • express ^4.18.2
    • typescript ^5.0.0

    TODO: Add environment variables for API_KEY.

    About This Skill

    Professional READMEs from Reality, Not Hallucinations

    Stop manually formatting documentation and wrestling with template headers. This skill automates the creation of polished, production-ready README files by deep-scanning your repository's actual structure and configuration files.

    What it does

    Unlike generic AI prompts that guess how your code works, this skill performs an environmental audit. It identifies your tech stack by inspecting manifests like package.json, pyproject.toml, go.mod, and Cargo.toml. It extracts real scripts, validates entry points, and maps dependencies to generate accurate installation and usage guides.

    Key Features

    • Multi-Language Support: Tailored documentation for Node/TypeScript, Python, Go, Rust, and Java environments.
    • Safe Inspection: Uses --help flags and manifest parsing to find commands without modifying your code.
    • Evidence-Based: Extract descriptions from docstrings and JSDocs rather than inventing project goals.
    • Dynamic Badges: Automatically includes license, version, and language badges based on detected metadata.

    Why use this skill?

    It eliminates "documentation drift." By grounding the output in your source code's reality, it ensures that if a script isn't in your manifest, it isn't in your README. It provides a standardized, professional structure that makes any repo "onboarding-ready" in seconds.

    Use Cases

    • Generate polished onboarding docs for a new open-source repository
    • Standardize README formats across a large microservice architecture
    • Extract API docs and usage examples directly from source code docstrings
    • Audit project manifests to update outdated installation instructions

    Reviews

    No reviews yet - be the first to share your experience.

    Only users who have downloaded or purchased this skill can leave a review.

    Security Scanned

    Passed automated security review

    Permissions

    Terminal / Shell
    Read Files
    Write Files

    File Scopes

    package.json
    requirements.txt
    go.mod
    Cargo.toml
    pom.xml
    **/*.js
    **/*.ts
    **/*.py
    **/*.go
    **/*.rs
    LICENSE
    README.md

    README Generator needs terminal access to run help commands (e.g., `npm run --help`) that generate usage examples. File read access scans manifest files, source code, and existing LICENSE files. File write access creates README.md — the user is always asked for confirmation before any file is written. No browser, network, or env var access required.

    Tags

    documentation
    readme
    devops
    automation
    onboarding

    Works with Claude Code and Codex. Supports Node.js, Python, Go, Rust, and Java projects.

    Creator

    Fairy Squadmother

    Fairy Squadmother sells skills for people with real work, limited patience, and a low tolerance for software pageantry. Her skills help creators, founders, freelancers, and practical humans turn repeatable messes into reusable systems. Promptcrud. Taskspawn. Filefog. Launch splatter. Documentation drift. The weird little admin barnacles that attach themselves to anything worth doing. She builds for the moment when you know the process can be better, but you do not have a spare week to go spelunking through your own workflow with a headlamp and a grudge. Clear instructions. Useful defaults. Less performance. More usable machinery. Onward.

    Frequently Asked Questions

    Learn More About AI Agent Skills

    More Premium Skills

    skill-router-2

    Automatically detect, load, and stack the perfect skills combo for any user request.

    $53 installs

    cinematic-sites

    Turn any basic business URL into a high-end cinematic landing page with AI-generated 4K assets and GSAP animations.

    $122 installs

    software-architect

    A structured framework for planning, reviewing, and evolving complex software systems with explicit trade-offs.

    $52 installs

    handoff-writer

    Generate high-density technical handoffs to resume work across agents or team members without losing context.

    $52 installs

    Free