SkillHub

wip-readme-format

v1.9.50

Reformat any repo's README to follow the WIP Computer standard.

Sourced from ClawHub, Authored by Parker Todd Brooks

Installation

Please help me install the skill `wip-readme-format` from SkillHub official store. npx skills add parkertoddbrooks/wip-readme-format

README Formatter

Reformats a repo's README to follow the WIP Computer standard. Agent-first, human-readable.

Commands

wip-readme-format /path/to/repo              # rewrite README.md
wip-readme-format /path/to/repo --dry-run    # preview without writing
wip-readme-format /path/to/repo --check      # validate, exit 0/1

What happens

  1. Detects all interfaces (CLI, Module, MCP, OC Plugin, Skill, CC Hook)
  2. Reads package.json for name, description, repo URL
  3. Reads SKILL.md for features
  4. Generates the README following the standard:
  5. WIP Computer header + interface badges
  6. Title + tagline
  7. "Teach Your AI" onboarding block
  8. Features list
  9. Interface coverage table (toolbox repos only)
  10. More Info links
  11. License block
  12. Moves technical content to TECHNICAL.md (never deleted)

The standard

[badges]
# Tool Name
Tagline.

## Teach Your AI to [verb]
[onboarding prompt block]

## Features
[feature list]

## Interface Coverage (toolbox only)
[auto-generated table]

## More Info
- Technical Documentation ... link
- Universal Interface Spec ... link

## License
[standard block]

Interfaces

CLI, Skill