Skip to content

README: lead with "Optimization Layer for AI Agents" positioning#76

Merged
anilmurty merged 1 commit into
mainfrom
docs/readme-optimization-positioning
May 30, 2026
Merged

README: lead with "Optimization Layer for AI Agents" positioning#76
anilmurty merged 1 commit into
mainfrom
docs/readme-optimization-positioning

Conversation

@anilmurty
Copy link
Copy Markdown
Contributor

Summary

Top-level README rewrite to reflect the v0.3.x product pivot. Lead surface is now the four optimization products in a 2×2 grid; everything a visitor sees in the first viewport ties to a savings outcome.

  • Tagline: "The Optimization Layer for AI Agents — cut LLM spend without changing what your agent does."
  • Above the fold: the 2×2 product grid (Downsize / Cache / Script / Trim) with one-line descriptions, emoji, the actual CLI command, and a deep-link to each product page.
  • No code or config in the first three sections — value prop lands before any setup detail.
  • Documentation table replaces the inline Python SDK / TypeScript SDK / Claude Code sections. Two new docs files absorb the moved content:
    • `docs/python-sdk.md`
    • `docs/typescript-sdk.md`

Footprint

  • README: 641 → 225 lines (65% shorter)
  • Added `docs/python-sdk.md` (79 lines)
  • Added `docs/typescript-sdk.md` (73 lines)
  • Net: −264 lines across the three files

Test plan

  • All markdown links in the new README resolve (audited via grep + filesystem check)
  • Screenshot paths unchanged (still under `docs/screenshots/`)
  • Render preview on GitHub looks attractive (deferred to reviewer eyeball)

🤖 Generated with Claude Code

Rewrites the top-level README to reflect the v0.3.x pivot. Lead surface
is now the four optimization products (Downsize / Cache / Script / Trim)
in a 2×2 grid with one-line descriptions and the actual CLI commands —
everything a visitor sees in the first viewport ties to a savings outcome.

Drops from the README and moves to dedicated docs:

  - Python SDK setup + patch table → docs/python-sdk.md (new)
  - TypeScript SDK setup + span builder → docs/typescript-sdk.md (new)

Removes redundant sections (the second Architecture H2, the lengthy
Claude Code section that was already mirrored in docs/, the verbose
CLI block) and replaces them with a single "Documentation" table that
points at the per-topic deep-dives.

README is now 225 lines (down from 641, 65% reduction). Every section
above the fold answers "what does this save me?" — no SDK setup, no
config TOML, no architecture diagrams before the value prop has landed.

No code changes; no version bump.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@anilmurty anilmurty merged commit 50e14f0 into main May 30, 2026
4 checks passed
@anilmurty anilmurty deleted the docs/readme-optimization-positioning branch May 30, 2026 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant