Works with the AI tools you already use

    Claude CodeClaude CodeCursorCursorCodex CLICodex CLIMuseMuseOpenClawOpenClaw+21 more

    README From Reality

    1

    Generate a polished README from what the repository actually contains, with verified commands and marked unknowns.

    Free

    1 installSecurity scanned
    README From Reality

    README From Reality

    Example session with this skill installed

    Generate a README from this repository evidence. Do not invent missing setup details.

    package.json

    • scripts: dev: vite, build: vite build, test: vitest
    • dependencies: React, Vite, Zod

    .env.example

    • VITE_API_URL=

    Files

    • src/main.tsx
    • src/api/client.ts
    • tests/
    • vite.config.ts

    The existing README only contains the project title.

    • Read your context and instructions
    • Compiled the readme from reality

    README DRAFT

    Project Name

    A React application built with Vite. The repository includes a typed API client and Vitest-based tests.

    Requirements

    • Node.js compatible with the repository's current toolchain
    • The repository's package manager/lockfile should be used for installation

    Configuration

    Create your local environment file from .env.example and provide:

    VITE_API_URL=

    Development

    Use the repository's package manager to install dependencies, then run the dev script.

    Available scripts

    • dev — starts Vite development mode
    • build — creates a production Vite build
    • test — runs Vitest

    DOCUMENTATION EVIDENCE

    Verified

    • React, Vite, Vitest, and Zod appear in package.json.
    • dev, build, and test scripts exist.
    • VITE_API_URL appears in .env.example.

    Inferred

    • src/api/client.ts suggests the application communicates with an external API.

    Missing / needs owner input

    • Exact Node.js version.
    • Product/business description.
    • Deployment method.

    Commands to verify before publishing

    • Run install using the detected lockfile's package manager.
    • Run dev, build, and test.

    Update triggers

    • Package scripts change.
    • Environment schema changes.
    • Deployment documentation is added.

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

    About this skill

    A README should describe the repository you have — not the repository an AI expects to exist.

    README From Reality generates polished developer documentation from the codebase itself: manifests, scripts, config, entry points, environment examples, tests, docs, CI, and deployment clues.

    The result is useful without pretending unknown things are known.

    What it does

    • Builds a fact map from the actual repository before writing.

    • Detects the real package manager, scripts, configuration, entry points, test setup, and environment requirements.

    • Separates verified repository facts from reasonable inference and missing owner knowledge.

    • Refuses to invent installation commands, environment variables, features, APIs, integrations, or deployment methods just to make the README look complete.

    • Uses the repository’s existing terminology instead of replacing it with generic AI marketing copy.

    • Produces a complete, copy-ready README with only the sections the project actually supports.

    • Adds an evidence appendix showing what was verified, inferred, or still missing.

    • Lists commands that should be run before publication when execution evidence is not available.

    • Defines the repository changes that should trigger a future documentation update.

    Use it when

    • a repository has no README
    • the README is stale or incomplete
    • AI-generated documentation contains suspicious commands or claims
    • onboarding instructions need to match the actual codebase
    • setup steps, environment variables, or scripts need verification
    • you want a professional README without hallucinated features

    What you get

    1. Complete README draft
    2. Verified repository facts
    3. Clearly marked inferences
    4. Missing information that needs owner input
    5. Commands to verify before publishing
    6. Documentation update triggers

    Why it is different

    Most README generators optimize for completeness and polish. This one optimizes for usefulness without losing contact with the repository.

    If the codebase does not support a claim, the skill does not quietly fill the gap.

    Known limitations

    A repository cannot reveal business positioning, private deployment procedures, undocumented external dependencies, or decisions that live only in team knowledge. Those gaps are surfaced explicitly instead of guessed.

    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

    1 install

    Downloaded by developers to date

    Free forever

    No account required to browse

    Trust & safety

    Security scanned

    Verified clean 11 days ago

    • Free to download with an account

    Listed11 days ago

    What's inside

    Frequently Asked Questions