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.

README: write it like a landing page v1.0.0

Use this resource to write a clear and scannable project README

New

  • 77 downloads
  • 198 likes
  • 92 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install readme-landing-page-rule

First time: connect the CLI with

npx --yes palatekit@latest login

Cursor applies these guidelines to README files: a hook that says what the project does and why it matters, a code example in the first five lines, tables for features, a copy-paste quick start with no $ prefix, and an author section with a badge. It bans empty marketing phrases and checks that referenced images exist.

Mostly picked by

Updated November 2, 2026

Card for “README: write it like a landing page”

Details

Works in
Install guides
Generates with
Your agent's model
Licence
CC0-1.0

Similar resources

View all

What you get

  • The .mdc file (in English): structure and tone guidelines for READMEs
  • Rules for the quick start and the project visuals

Good fit for

  • An open source repository that must convince in seconds
  • A README that is too technical and needs rewriting for beginners

Not for

    Tags

    • readme
    • documentation
    • open source
    • writing

    About

    You say

    “Rewrite this repository's README with a hook and a quick start.”

    Card for “README: write it like a landing page”

    Rule published by PatrickJS under the CC0-1.0 license, delivered in its original version.

    Show more

    How to use it

    1. Copy the .mdc file into your project's .cursor/rules/ folder
    2. Ask Cursor to write a clear and scannable project README
    3. Adjust the rule to your conventions

    Content preview

    Files

    • LICENSE6.5 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • readme-landing-page-rule.mdc1.1 KB

    Origin and licence

    Listed unmodified

    Author
    PatrickJS
    Source
    github.com/PatrickJS/awesome-cursorrules/blob/b044f956f021b6e8877f16781bcfc466a6a120e9/rules/readme-best-practices-cursorrules-prompt-file.mdc
    Licence
    CC0-1.0

    Notice

    « readme-best-practices-cursorrules-prompt-file » (PatrickJS, CC0-1.0) 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.