# Readme Writer

> Readme Writer

- Skill: `demerzels-lab/readme-writer` (Agent Skill, multi-file: 8 files)
- Install (CLI): `npx skillmds@latest add demerzels-lab/readme-writer`
- Raw SKILL.md: https://api.skillmd.com/api/skills/demerzels-lab/readme-writer/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: Demerzels-lab (https://skillmd.com/u/demerzels-lab)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/demerzels-lab/readme-writer

---

# Readme Writer

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

## Quick Start

```bash
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

```bash
# 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:**
- GitHub: https://github.com/lxgic-studios
- Twitter: https://x.com/lxgicstudios
- Substack: https://lxgicstudios.substack.com
- Website: https://lxgicstudios.com

## License

MIT. Free forever.