1---2name: readme-writer3description: Readme Writer4---5# Readme Writer67Generate polished README.md files from your codebase automatically. No more staring at a blank page.89## Quick Start1011```bash12npx ai-readme13```1415## What It Does1617- Analyzes your codebase structure18- Generates professional README with all sections19- Adds appropriate badges (npm, license, etc.)20- Creates install/usage instructions from your code21- Includes API documentation from your exports2223## Usage2425```bash26# Generate README for current project27npx ai-readme2829# Output to specific file30npx ai-readme --output ./README.md31```3233## Generated Sections3435- Project title and description36- Installation instructions37- Usage examples38- API reference39- Contributing guidelines40- License info4142## Part of the LXGIC Dev Toolkit4344One of 110+ free developer tools from LXGIC Studios. No paywalls, no sign-ups.4546**Find more:**47- GitHub: https://github.com/lxgic-studios48- Twitter: https://x.com/lxgicstudios49- Substack: https://lxgicstudios.substack.com50- Website: https://lxgicstudios.com5152## License5354MIT. Free forever.
Run npx skillmds@latest add kernel8901/readme-writer in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
Readme Writer It is listed under Coding & Dev Tools on SkillMD.
This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
kernel8901 (@kernel8901) published this skill. Their other Agent Skills are listed on their SkillMD profile.
kernel8901