{"filename":"readme-best-practices-cursorrules-prompt-file.mdc","content":"---\ndescription: \"Cursor rules for README documentation with best practices integration.\"\nglobs: **/*\nalwaysApply: false\n---\nWrite READMEs like landing pages, not API docs. The reader decides in 3-5 seconds.\n\nStart with a bold one-liner saying what it does and why someone should care. Not \"A tool that...\" - a punchline.\nPut a working code example in the first 5 lines. Show the value prop immediately.\nUse feature tables (two columns) instead of **Feature:** bullet lists. Tables scan faster.\nQuick Start must be copy-paste ready. No $ prefix on bash commands. Zero to running in 30 seconds.\nVary sentence lengths and structure. Mix one-liners with short paragraphs and tables. Not walls of same-length bullets.\nNever use \"seamless\", \"robust\", \"comprehensive\", \"cutting-edge\", or other AI marketing words.\nNever open with \"In today's...\" or close with \"Happy coding!\"\nCheck that referenced assets (demo.gif, screenshots) actually exist on disk before adding image links.\nAuthor section should include a visual card or badge, not just plain text \"Made by username\".\n"}