feat: README overhaul + savings badge CLI for growth#111
Merged
Conversation
- Add uvx one-liner as primary install method (shareable, zero-install) - Update savings example to show new format (freshness hint, per-bucket breakdown, multi-provider pricing) - Collapse system requirements into expandable section (unblocks the quick start flow) - Remove duplicate "How is CCE different" section - Update pricing references to reflect multi-provider support (15+ models) - Fix config file references (config.yaml, not cce.toml)
Growth-focused blog post that: - Shows the math on input vs output token costs (85-95% is input) - Explains why output compression alone saves ~8% while retrieval saves ~61% - Positions CCE as the input-side solution with real benchmark numbers - Includes the uvx one-liner install - Neutral tone, no competitor bashing, complementary framing Target channels: dev.to, r/ClaudeAI, r/LocalLLM, Hacker News
After indexing completes, show: - Codebase size in tokens and dollar cost to read in full - Estimated savings per full read (94% retrieval benchmark) - Clear next steps: restart agent, run cce savings Before: "Done! Restart your AI coding agent to activate CCE." After: Codebase: 764k tokens ($11.46 to read in full) Estimated savings per full read: ~$10.77 (94% retrieval savings) ✓ Ready! Restart your AI coding agent to activate CCE. Run cce savings after a few queries to see actual savings.
rajkumarsakthivel
requested review from
fazleelahhee
and removed request for
fazleelahhee
Every agent doc now includes: - Verification steps (how to confirm CCE is active) - Troubleshooting section (common issues + fixes) - Windows-specific notes (encoding, PATH) - Cross-agent memory explanation - Correct MCP config examples with --project-dir Agents updated: Claude Code, VS Code/Copilot, Cursor, Codex CLI, Gemini CLI, OpenCode, Tabnine, and the overview page.
Generates three shareable formats: - Markdown badge (shields.io, paste into README) - Social share text (copy to Twitter/LinkedIn/Reddit) - Raw badge URL Badge shows: CCE | $X saved | Y% tokens saved Color: brightgreen (80%+), green (50%+), yellowgreen (<50%) Example output: [](...)
11-slide dark-theme HTML presentation: 1. Title + key metrics (94%, 0.4ms, 0.90 recall) 2. The problem (45k tokens to answer one question) 3. Input vs output (90/10 split, why output compression = 8%) 4. Architecture (5-stage pipeline diagram) 5. Hybrid retrieval deep dive (vector + BM25 + RRF) 6. FastAPI benchmark (reproducible numbers) 7. Multi-agent support (7 agents, one index) 8. Cross-session memory 9. Real savings tracking (per-bucket breakdown) 10. Try it (uvx one-liner) 11. CTA Self-contained HTML, keyboard nav, touch/swipe, progress bar.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes the public-facing docs/README to improve onboarding and marketing, and adds small CLI UX improvements around savings visibility and sharing.
Changes:
- Update README quick start to highlight
uvxone-liner install/init, revise savings example formatting, and adjust system requirements + pricing text. - Add a new
cce savings --badgeoutput mode that prints a shareable shields.io badge plus a social snippet. - Add new marketing collateral pages (presentation + blog post) under
docs/.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/context_engine/cli.py | Adds post-init “payoff” output and introduces cce savings --badge / shortcut support. |
| README.md | Reworks onboarding flow, savings example, requirements section, and pricing/config references. |
| docs/presentation/aie-2026.html | Adds a standalone HTML slide deck for AIE 2026 presentation. |
| docs/blog/real-cost-of-ai-coding-tokens.html | Adds a standalone HTML blog post explaining input vs output token costs. |
| docs-src/src/content/docs/agents/tabnine.md | Updates Tabnine MCP args and adds verification/troubleshooting guidance. |
| docs-src/src/content/docs/agents/overview.md | Updates agent matrix, adds cross-agent memory + common issues section. |
| docs-src/src/content/docs/agents/opencode.md | Updates OpenCode setup docs and MCP config snippet. |
| docs-src/src/content/docs/agents/gemini.md | Updates detection notes, MCP args, and adds verification/troubleshooting guidance. |
| docs-src/src/content/docs/agents/cursor.md | Expands Cursor integration guidance and adds verification/troubleshooting steps. |
| docs-src/src/content/docs/agents/copilot.md | Updates VS Code MCP config snippet/notes and adds verification + troubleshooting. |
| docs-src/src/content/docs/agents/codex.md | Updates Codex config explanation (slug/sections), adds verification + troubleshooting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
rajkumarsakthivel
changed the title
- Fix badge URL encoding: remove safe="|" from quote() so pipe chars get properly percent-encoded for shields.io - Fix README: "Two commands" → "One command" to match single uvx line - Fix OpenCode docs: config snippet now matches actual CCE output (type: "local" with command as array) - PR title updated to reflect CLI feature additions
fazleelahhee
approved these changes
Jun 18, 2026
fazleelahhee
approved these changes
Jun 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
uvxone-liner as primary install method (shareable, zero-install)