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

# Show help
readme help

# Quick start
readme run

Examples

# 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