Skip to content

docs: rewrite README header with value proposition and comparison table#41

Merged
cablate merged 4 commits intomainfrom
docs/readme-header
Mar 14, 2026
Merged

docs: rewrite README header with value proposition and comparison table#41
cablate merged 4 commits intomainfrom
docs/readme-header

Conversation

@cablate
Copy link
Owner

@cablate cablate commented Mar 14, 2026

Summary

Rewrite the first ~30 lines of README for stronger first impression:

  • One-liner: "Give your AI agent the ability to understand the physical world"
  • 3-bullet highlights: 8 tools, 3 modes, Agent Skill
  • vs Grounding Lite table: side-by-side comparison showing our 8 tools vs their 3
  • Quick Start: all 3 modes (stdio, exec, HTTP) in one block
  • Remove verbose "Important Notice" box and "Verified Compatibility" section

Rest of README unchanged.

Preview

The header now answers three questions immediately:

  1. What does it do? → one-liner
  2. Why choose this over Google's? → comparison table
  3. How do I start? → 3-line quick start

🤖 Generated with Claude Code

cablate and others added 4 commits March 14, 2026 14:41
- Add one-liner value proposition
- Add 3-bullet feature highlights (8 tools, 3 modes, Agent Skill)
- Add vs Google Grounding Lite comparison table
- Consolidate Quick Start to show all 3 modes
- Remove verbose compatibility section and Important Notice box

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- One-click install badges for VS Code and VS Code Insiders
- npm version, license, and monthly downloads shields

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@cablate cablate merged commit 3c9efb2 into main Mar 14, 2026
1 check passed
@cablate cablate deleted the docs/readme-header branch March 14, 2026 07:08
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