documentation/create-readme/SKILL.md
Create a README.md file for the project
npx skillsauth add beel-collab/presets create-readmeInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.
development
Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.
documentation
Create a tldr page from documentation URLs and command examples, requiring both URL and command name.
testing
Create an llms.txt file from scratch based on repository structure following the llms.txt specification at https://llmstxt.org/
documentation
Convert a text-based document to markdown following instructions from prompt, or if a documented option is passed, follow the instructions for that option.