{"owner":"yetone","repo":"README","hasSkills":true,"totalSkillsCount":1,"totalTokensCount":238,"categories":["cursor-rule"],"hasMcp":false,"mcpConfig":null,"found":[".cursorrules (readme-best-practices-cursorrules-prompt-file.mdc)"],"skills":{".cursorrules (readme-best-practices-cursorrules-prompt-file.mdc)":"---\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"},"files":{".cursorrules (readme-best-practices-cursorrules-prompt-file.mdc)":"---\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"},"items":[{"name":".cursorrules","path":".cursorrules (readme-best-practices-cursorrules-prompt-file.mdc)","rawUrl":"https://raw.githubusercontent.com/PatrickJS/awesome-cursorrules/main/rules/readme-best-practices-cursorrules-prompt-file.mdc","title":"Awesome Cursorrules: readme best practices","category":"cursor-rule","format":"markdown","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","tokens":238,"sizeBytes":1067}],"systemPromptSnippet":"<yakaai_skills repo=\"yetone/README\">\n<!-- File: .cursorrules (readme-best-practices-cursorrules-prompt-file.mdc) (Tokens: ~238 | Category: cursor-rule) -->\n---\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</yakaai_skills>"}