Commit a35d8a3
Simplify README and recreate AGENTS.md
## Changes
### README.md
- **Simplified structure** - Reduced from 294 to 220 lines (~25% reduction)
- **Removed excessive details**:
- Database schema tables (moved to CLAUDE.md reference)
- Detailed Ollama mode explanations (kept basic info)
- Extended provider examples (kept concise examples)
- Overly detailed architecture section (simplified to diagram + flow)
- **Kept essential content**:
- Key features (concise bullet points)
- Quick Start (installation + basic run)
- Configuration (first-time setup with examples)
- What's new in v0.6.0
- Common tasks section (how to add providers, sync, etc.)
- Simple architecture diagram
- Links to detailed docs
- **Better organization**:
- Quick Start at the top
- Configuration next
- Common tasks for quick reference
- Links to detailed docs for deep dives
### AGENTS.md (recreated)
- Points AI coding assistants to CLAUDE.md for detailed guidance
- Provides version bump instructions
- Links to documentation structure
- Includes brief version history
## Rationale
**README purpose**: Help users understand and start using the project quickly
**CLAUDE.md purpose**: Detailed developer/architecture documentation
**docs/ purpose**: Technical references and guides
The previous README tried to be both user guide AND technical reference,
making it overwhelming for new users. Now:
- Users get quick start and essentials in README
- Developers get full details in CLAUDE.md
- Technical specs in docs/reference/
- How-to guides in docs/guides/
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>1 parent 10ca689 commit a35d8a3
2 files changed
+147
-195
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
0 commit comments