Skip to content

README rewrite: outcome-led headline, demo GIF/screenshot, before/after #53

@greynewell

Description

@greynewell

Problem

The current README headline is: "Give your AI coding agent a map of your codebase."

Nobody knows if they want that. The README sells features (call graphs, blast radius) instead of outcomes (Claude stops hallucinating about your codebase).

Solution

New headline

Claude now understands your entire codebase — not just the files you paste in.

Demo GIF / screenshot

The single most important asset missing. Should show:

  • Before: Claude hallucinating about a function that exists elsewhere in the codebase
  • After: Claude answering correctly because it read the .graph file via grep

Or alternatively: terminal recording of supermodel watch starting, showing the stats summary (files mapped, functions, dead code found), then Claude Code referencing graph data in a response.

Restructure

Current structure: install → commands list → config.

Proposed:

  1. Hero — headline + one-liner value prop + demo GIF
  2. How it works — 3-step visual (install → watch → ask Claude anything)
  3. Quick start — just the install command and first command
  4. Commands — current content, trimmed
  5. Configuration — current content

Audience expansion

Add a clear note that .graph files work with any agent that can run grep/cat — Cursor, Copilot, Windsurf, etc. Not Claude-only.

Why this matters

The README is the top-of-funnel conversion page. Every person who lands on the GitHub repo and doesn't install is a lost user. A before/after GIF does more than 500 words of documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions