wip-readme-format

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

Safety Notice

This listing is from the official public ClawHub registry. Review SKILL.md and referenced scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "wip-readme-format" with this command: npx skills add Parker Todd Brooks/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:
    • WIP Computer header + interface badges
    • Title + tagline
    • "Teach Your AI" onboarding block
    • Features list
    • Interface coverage table (toolbox repos only)
    • More Info links
    • License block
  5. 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

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Open Registry RecordOpen in ClawHub