Readme Writer

Generate polished README.md files from your codebase automatically. No more staring at a blank page.

modbender Updated 12 repo stars

File contents

Readme Writer

Generate polished README.md files from your codebase automatically. No more staring at a blank page.

Quick Start

npx ai-readme

What It Does

  • Analyzes your codebase structure
  • Generates professional README with all sections
  • Adds appropriate badges (npm, license, etc.)
  • Creates install/usage instructions from your code
  • Includes API documentation from your exports

Usage

# Generate README for current project
npx ai-readme

# Output to specific file
npx ai-readme --output ./README.md

Generated Sections

  • Project title and description
  • Installation instructions
  • Usage examples
  • API reference
  • Contributing guidelines
  • License info

Part of the LXGIC Dev Toolkit

One of 110+ free developer tools from LXGIC Studios. No paywalls, no sign-ups.

Find more:

License

MIT. Free forever.

modbender/skill-library-mcp/tree/main/data/readme-writer commit 9b6847544d

Frequently asked questions

npx skillmds@latest add modbender/readme-writer