mirror of
https://github.com/rtk-ai/rtk.git
synced 2026-09-19 07:33:17 +08:00
Florian BRUNIAUX
8c67a2f1e7
## README.md Updates **Quick Start section:** - Clear 3-step process: verify → install hook → test - Prominently recommend `rtk init -g` (hook-first mode) - Explain 99.5% token savings (2000 → 10 tokens) - Show alternative modes (--claude-md, local init) **Configuration section:** - New comparison table: 4 modes with token costs - Migration instructions for existing users - Clarify hook vs CLAUDE.md injection differences **Auto-Rewrite Hook section:** - Promote automated install (`rtk init -g`) as primary method - Keep manual install as fallback - Add verification step (`rtk init --show`) ## INSTALL.md Updates **Project Initialization:** - Recommend global hook-first setup (with rationale) - Show token savings: 99.5% reduction - Document local setup as alternative - Add upgrade/migration guide for existing users ## TROUBLESHOOTING.md Updates **RTK not working section:** - Option A: Automated (`rtk init -g`) - recommended - Option B: Manual install - fallback - Clarify absolute path requirement in settings.json - Add verification step ## Fixes Documentation Gaps Before: - ❌ No mode comparison - ❌ No migration guide - ❌ Manual install only - ❌ Unclear token impact After: - ✅ Clear mode comparison with use cases - ✅ Automatic migration documented - ✅ Automated install prioritized - ✅ Quantified token savings (99.5%) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>