Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Sign in
Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

A page, a video or an image online.

Unlock PalateKit

Unlock everything

Plan

Paying means accepting our terms of sale.

Secure payment by Stripe. Receipts and invoices sent by email.

Welcome back

Sign in to install, download or save this resource. A free account is enough for free resources.

Repository-accurate README writing subagent v1.0.0

Use this resource to write a README that matches the repository's actual code

New

  • 359 downloads
  • 175 likes
  • 155 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install readme-writing-subagent

First time: connect the CLI with

npx --yes palatekit@latest login

The readme-generator subagent is called to produce a README. It goes through code, scripts, manifests and tests to extract the real installation steps, commands and variables. It uses web search only for framework context, and commits or pushes only when you explicitly ask.

Mostly picked by

Updated November 2, 2026

Card for “Repository-accurate README writing subagent”

Details

Works in
Install guides
Generates with
Your agent's model
Licence
MIT

Similar resources

View all

What you get

  • The subagent file (in English): role, repository scan method and anti-invention rules
  • A README with installation, usage and examples taken from the repository

Good fit for

  • A project with no README or an outdated one
  • A repository about to be published whose installation steps must be verified

Not for

    Tags

    • readme
    • documentation
    • repository
    • installation

    About

    You say

    “Write this repository's README from the code, without inventing any command.”

    Card for “Repository-accurate README writing subagent”

    Subagent published by VoltAgent under the MIT license, delivered in its original version.

    Show more

    How to use it

    1. Copy the file into .claude/agents/ (project) or ~/.claude/agents/ (all your projects)
    2. Ask your agent to write a README that matches the repository's actual code, or call the subagent by name
    3. Review its work

    Content preview

    Files

    • LICENSE1.1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • readme-writing-subagent.md6.8 KB

    Origin and licence

    Listed unmodified

    Author
    VoltAgent
    Source
    github.com/VoltAgent/awesome-claude-code-subagents/blob/f2e2ea7e0202cc05fa2d469fcb2c57fe08603450/categories/06-developer-experience/readme-generator.md
    Licence
    MIT

    Notice

    « readme-generator » (VoltAgent, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    User reviews

    –

    No ratings yet

    Loading reviews…

    Delete your review?

    Your rating and comment will be removed from the page.