Skip to content

[Docs] Redesign README for plugin marketplace identity #57

@Kanevry

Description

@Kanevry

Context

WondrAIWork is now a Claude Code Plugin Marketplace (since Phase A completion). The current README positions it purely as a methodology repo. It needs to reflect the dual identity: usable tool (plugin + skills) AND methodology showcase.

Supersedes the incremental README changes in #42 and #43 — this is a full redesign.

Current Problems

  1. No mention of the plugin — visitors don't know they can install and use this directly in Claude Code
  2. Quick Start is git-clone focused — should lead with /plugin marketplace add for tool users
  3. No proven results — 2 completed contributions (refined-github, react-router) aren't showcased
  4. No skills table — 8 skills (2 built, 6 planned) aren't visible
  5. Feature list is generic — doesn't communicate the unique value proposition vs other tools
  6. Missing badges — no version badge, no Claude Code Plugin badge

Proposed Structure

Banner
Tagline + Badges (MIT, Stars, Issues, Version, Claude Code Plugin)

## What is WondrAIWork?
One paragraph: systematic 7-phase methodology + Claude Code plugin for AI-assisted OSS contributions.
Not a bot. Not "good first issue" farming. Real contributions to real projects.

## Install as Claude Code Plugin
/plugin marketplace add Kanevry/wondraiwork

### Available Skills
| Skill | Description | Status |
| /discover | Find high-impact issues | Available |
| /evaluate | Deep-evaluate repo + issue viability | Available |
| /contribute | Full 7-phase workflow orchestrator | Coming |
| /verify | Pre-PR verification gate | Coming |
| /briefing | Owner briefing (Phase 02b) | Coming |
| /setup | Clone + prepare target repo | Coming |
| /track | Manage targets + log decisions | Coming |
| /review | Quality-gate diff review | Coming |

## Proven Results
| Contribution | Repo | Status |
| DOM selector fix | refined-github | PR #9128 submitted |
| Vite module resolution | react-router | PR #14936 submitted |

## The 7-Phase Methodology
(condensed version of current methodology section)

## Use Without Plugin
pnpm discover / evaluate / setup-target
(current Quick Start, moved down)

## Contribution Targets
(current targets section)

## Philosophy
(keep as-is)

## AI Transparency
(keep as-is)

## Contributing
(keep as-is)

## License

Key Design Decisions

  • Plugin installation is the primary CTA — above the fold, before methodology
  • Skills table shows current + planned — communicates scope and progress
  • Proven results create credibility — real PRs in real repos
  • CLI usage as secondary path — for people who want the scripts without the plugin
  • Badges at top — version, license, stars, Claude Code Plugin

Closes

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions