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.

Write a complete README for a project v1.0.0

Use this resource to write a complete README with installation, usage and contribution guidance

New

  • 563 downloads
  • 116 likes
  • 163 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install readme-writer

With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.

First time: connect the CLI with

npx --yes palatekit@latest login

The agent writes a complete README: header with badges, description, features, installation, usage, API documentation and contribution rules. It adapts the outline to the project it analyzes. You get a README ready to publish.

Mostly picked by

Updated November 2, 2026

Card for the “Write a complete README for a project” skill

Details

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

Similar resources

View all

What you get

  • SKILL.md: README template with header, features and demo
  • SKILL.md: installation, quick start and prerequisites sections

Good fit for

  • Your project has no README or a very incomplete one
  • You publish an npm library and want a clear landing page

Not for

    Tags

    • readme
    • documentation
    • installation
    • project

    About

    You say

    “Write the README for this npm library, with pnpm installation and a usage example.”

    Card for the “Write a complete README for a project” skill

    Skill published by patricio0312rev under the MIT license, delivered in its original version.

    Show more

    How to use it

    1. Install the skill in your agent's skills folder
    2. Ask your agent to write a complete README with installation, usage and contribution guidance
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE1.1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md13.3 KB

    Origin and licence

    Listed unmodified

    Author
    patricio0312rev
    Source
    github.com/patricio0312rev/skills/tree/79ea6af485698b31060b63f0066f712560757b29/foundation/readme-generator
    Licence
    MIT

    Notice

    « readme-generator » (patricio0312rev, 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.