Add README best practices rule

[ofershap]

Adds a cursor rule for writing better READMEs. Agents default to dry, template-style docs with generic openings and bold-label bullet lists. This rule teaches them to write READMEs like landing pages - punchline first, feature tables, copy-paste install blocks.

Source: https://github.com/ofershap/readme-best-practices

Summary by CodeRabbit

• Documentation

  • Added comprehensive README best practices guide with recommendations for documentation structure, formatting standards, content organization, and effective writing techniques to improve readability and user experience.

• Chores

  • Updated documentation references to include new best practices standards.

[coderabbitai]

📝 Walkthrough

Walkthrough

A new README best practices cursor rule has been added to the repository. The README.md file references this new rule, and a new .cursorrules file in the rules/readme-best-practices-cursorrules-prompt-file/ directory contains detailed guidance on writing effective, reader-centric READMEs.

Changes

Cohort / File(s)	Summary
README Documentation README.md	Added reference to the new README Best Practices cursor rule in two sections (Frontend Frameworks and Libraries, and Other sections).
README Best Practices Guide rules/readme-best-practices-cursorrules-prompt-file/.cursorrules	New guidance file establishing standards for README writing, including scannability targets, code example placement, feature table formatting, Quick Start command structure, copywriting guidelines, and author section enhancements.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

• PatrickJS

Poem

🐰 Hops with glee through README's page,
Best practices, wisdom of the age,
Bold first lines and code that shines,
Tables neat with proper lines,
Scannability in seconds five—
Reader-focused docs alive! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Add README best practices rule' clearly and directly summarizes the main change: adding a new cursor rule file for README best practices guidance.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 277: Move the README rule entry "[README Best
Practices](./rules/readme-best-practices-cursorrules-prompt-file/.cursorrules)"
out of the "### Other" section and add it under the "### Documentation" section
in README.md; specifically, remove the line currently listed under Other and
insert the same markdown list item into the Documentation category so the rule
is documented under the correct heading.

---

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fc2ce04 and 4643ef6.

📒 Files selected for processing (2)

• README.md
• rules/readme-best-practices-cursorrules-prompt-file/.cursorrules

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Move this rule to the Documentation category.

README Best Practices is documentation-centric and should be listed under ### Documentation, not ### Other, to keep category semantics accurate.

♻️ Proposed fix

@@
-- [README Best Practices](./rules/readme-best-practices-cursorrules-prompt-file/.cursorrules) - Cursor rules for README documentation with best practices integration.
@@
 ### Documentation
 
 - [Gherkin Style Testing](./rules/gherkin-style-testing-cursorrules-prompt-file/.cursorrules) - Cursor rules for Gherkin style testing development with integration.
 - [How-To Documentation](./rules/how-to-documentation-cursorrules-prompt-file/.cursorrules) - Cursor rules for how-to documentation development with integration.
+- [README Best Practices](./rules/readme-best-practices-cursorrules-prompt-file/.cursorrules) - Cursor rules for README documentation with best practices integration.

As per coding guidelines: "Update the README.md file when adding new .cursorrules files, placing them in the correct category."
Based on learnings: "Update the README.md file when adding new .cursorrules files, placing them in the correct category."

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 277, Move the README rule entry "[README Best
Practices](./rules/readme-best-practices-cursorrules-prompt-file/.cursorrules)"
out of the "### Other" section and add it under the "### Documentation" section
in README.md; specifically, remove the line currently listed under Other and
insert the same markdown list item into the Documentation category so the rule
is documented under the correct heading.