# Readme

> Generate README files with badges, TOC, and API docs. Use when scaffolding project docs, validating structure, generating contents, formatting references.

- Skill: `bytesagain/readme` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add bytesagain/readme`
- Raw SKILL.md: https://api.skillmd.com/api/skills/bytesagain/readme/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- License: MIT-0
- Author: bytesagain (https://skillmd.com/u/bytesagain)
- Updated: 2026-09-09
- Page: https://skillmd.com/skills/bytesagain/readme

---


# Readme

README generator — project documentation, badge generation, table of contents, API docs, installation guides, and template library.

## Commands

| Command | Description |
|---------|-------------|
| `readme run` | Execute main function |
| `readme list` | List all items |
| `readme add <item>` | Add new item |
| `readme status` | Show current status |
| `readme export <format>` | Export data |
| `readme help` | Show help |

## Usage

```bash
# Show help
readme help

# Quick start
readme run
```

## Examples

```bash
# Run with defaults
readme run

# Check status
readme status

# Export results
readme export json
```

- Run `readme help` for all commands
- Data stored in `~/.local/share/readme/`

---
*Powered by BytesAgain | bytesagain.com*
*Feedback & Feature Requests: https://bytesagain.com/feedback*

## When to Use

- Quick readme tasks from terminal
- Automation pipelines

## When to Use

- Quick readme tasks from terminal
- Automation pipelines