Michael Ramos d3fd62297b feat(readme): redesign README (#891) ...

* feat(readme): redesign README — hero banner, agent icons, simplified install

- New centered hero: banner, tagline, theme-aware agent icon row (picture/prefers-color-scheme), demo links
- Intro paragraph naming all nine supported agents
- Feature cards with screenshots; dedicated Annotate HTML Artifacts, Code review, and Sharing sections
- Install collapsed to one shared installer + per-agent table covering all nine agents, linking each app README
- New Try it section for manual invocation after install
- Fixed Codex plan-mode claim (supported via Stop hook), completed PLANNOTATOR_ORIGIN values, fixed demo links and typos
- Added Integrations, Remote/SSH, Security, and Configuration sections

* feat(readme): consolidate command examples into a Commands section

- Annotate HTML Artifacts is now screenshot-only
- Drop the duplicate code review screenshot (code-review-thumbnail.png removed)
- New Commands section: Annotate, Code review, and CLI groups

* fix(readme): point doc-review demo at Pi video, drop wrong code review demo link

* style(readme): plain-language pass

- No em dashes anywhere; split into sentences or swapped for colons/commas
- Rewrote the intro: integration with the agent session is now explicit (plugs into hooks/commands, feedback lands back in the live session)
- Varied repeated phrasing between the two feature cards
- Integration labels use colons instead of dashes

* style(readme): simplify feedback phrasing in hero and feature card

* feat(readme): add Plan mode note and sessions command to Commands section

* feat(readme): sharing beta link and Workspaces signup CTA badge

* style(readme): drop divider between feature table and HTML artifacts section

* style(readme): bump banner width 512 -> 640

* style(readme): fix agent icon sizing

- Crop Pi icon viewBox to glyph bounds (was 40% padding)
- Render Amp at 32px to offset its thin mark

* style(readme): bump Amp icon to 38px for visual parity

* fix(readme): strip em-based size attrs from Amp icon so it scales

The svg root had width/height of 1em plus an inline style, the only icon
in the set with relative sizing. SVG-as-image resolves em at a fixed 16px
and the drawing stayed pinned there regardless of the img height. Removed
the attrs, back to the uniform 28px row height.

* style(readme): width=100% on feature table images

* style(readme): cmux-style 40/60 feature table with middle-aligned text

* style(readme): split feature rows into separate tables so zigzag keeps 40/60

* style(readme): single feature table, text left 40 / image right 60, no zigzag

* style(readme): tighten intro and feature card copy

* style(readme): remove stray space before period

* style(readme): another round of copy edits

* chore: remove internal docs notes, move readme-assets to .github/assets

- Deleted docs/ (three internal handoff notes, nothing referenced them)
- README media now lives in .github/assets/ instead of a root-level folder
- All 18 asset links in README updated

* style(readme): split intro into two paragraphs

* feat(readme): live collaboration teaser in Sharing, tighten encryption copy

* style(readme): retitle Sharing & Multiplayer, rework CTA badge to banner palette with balloon

* feat(readme): updated annotate and review screenshots

* feat(readme): updated HTML artifact screenshot

* feat(readme): swap HTML artifact screenshot for v2

* feat(readme): restore share workflow sentence and Codex command note

* docs(agents): document bun link workflow for local plannotator command

* style(readme): trim Windows note from Codex command tip

* feat(readme): one-line AI features note under feature table

2026-06-11 13:10:50 -07:00

128 KiB

1996x1252px

Raw Permalink History