More screenshots

    Works with the AI tools you already use

    Claude CodeClaude CodeCursorCursorCodex CLICodex CLIMuseMuseDotsDots+22 more

    readme generator

    1

    Generate and audit evidence-grounded READMEs by inspecting repository source code and manifests.

    Free

    3 installsSecurity scanned

    readme generator

    Example session with this skill installed

    Audit my current README.md against the repository files and generate a corrected version that only includes verified scripts and env vars.

    • Read your context and instructions
    • Compiled the readme generator

    I have audited the repository and found 2 stale scripts in the README (build:prod and deploy) that are no longer in package.json. I also detected a missing DATABASE_URL environment variable required by src/db/client.ts that was not documented.

    Updated README.md

    Project Phoenix — Backend Service

    A Node.js microservice for processing asynchronous telemetry data using Fastify and Redis.

    Requirements

    • Node.js v18.x or higher
    • Redis v7.0+
    • PostgreSQL v14+

    Configuration

    Create a .env file in the root directory. The following variables are required for the application to start:

    VariableSourcePurpose
    DATABASE_URLsrc/config/db.tsPostgreSQL connection string
    REDIS_HOSTsrc/config/cache.tsRedis server hostname
    API_KEYsrc/middleware/auth.tsThird-party service authentication

    Available Scripts

    Based on the package.json manifest, you can run the following commands:

    
# Install dependencies
npm install

# Start development server with hot-reload
npm run dev

# Run unit tests via Vitest
npm run test

# Build the project for production
npm run build

    Project Structure

    • src/api/: Fastify route definitions.
    • src/db/: Prisma schema and client configuration.
    • src/workers/: Background job processing logic.
    • tests/: Integration and unit test suites.

    License

    MIT License - see the LICENSE file for details.

    Next steps

    1. Review the newly added DATABASE_URL section to ensure the description matches your deployment environment.
    2. Remove the deprecated deploy.sh script if it is no longer needed.
    3. Verify that the Redis version requirement matches your production cluster.
    Updated README.md

    Connects securely to your tools. The creator never sees your data.

    About this skill

    The problem

    Writing READMEs manually leads to "documentation rot" where scripts, environment variables, and setup steps drift from the actual code. Developers often waste time troubleshooting outdated instructions or inventing generic sections that don't reflect the repository's reality.

    What it does

    • Performs a repository-wide inventory of manifests, lockfiles, and source trees to establish a source of truth.
    • Maps every documented command to an actual script or entry point found in the codebase.
    • Identifies project types and ecosystems automatically to generate relevant sections without generic filler.
    • Detects and redacts sensitive credentials, tokens, and private keys during the documentation process.
    • Audits existing READMEs to flag stale claims and unsupported environment variables against the current state of the repo.

    Why this beats prompting it yourself

    Most LLMs hallucinate "standard" setup commands like npm install or python main.py regardless of what is actually in your repo. This skill enforces a strict evidence hierarchy, ensuring every instruction is backed by a file, script, or config entry, preventing the creation of plausible-sounding but broken documentation.

    Use cases

    • Generating a comprehensive README for a new repository based on the initial scaffold.
    • Auditing a legacy project to find and fix broken installation steps or missing environment variables.
    • Documenting complex monorepos by mapping entry points and scripts across multiple packages.
    • Standardizing documentation across a team by enforcing evidence-based reporting.

    How to install

    Works the same in every agent - Claude, Cursor, Codex, Copilot and 20+ more.

    ~30 seconds
    1. 1

      Download the ZIP

      Free skills download straight away. Paid skills unlock right after purchase.

    2. 2

      Unzip into your skills folder

      Every agent reads skills from one folder on your machine. Drop the unzipped folder in there.

    3. 3

      Ask your agent to use it

      Restart the agent if it was already running. It picks the skill up automatically - no config needed.

    Skills folder by agent

    Click the path to copy it. Create the folder if it does not exist yet.

    Reviews

    No reviews yet

    Be one of the first to try it. Every listed skill passes our trust checks below.

    Security scanned

    Passed our 8-point scan before listing

    3 installs

    Downloaded by developers to date

    Free forever

    No account required to browse

    Trust & safety

    Security scanned

    Verified clean 18 days ago

    • Free to download with an account

    Listed18 days ago

    What's inside

    Frequently Asked Questions