Skip to content

Commit a35d8a3

Browse files
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

File tree

2 files changed

+147
-195
lines changed

2 files changed

+147
-195
lines changed

AGENTS.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# AGENTS.md
2+
3+
This repository includes instructions for AI coding assistants.
4+
5+
## For AI Coding Assistants
6+
7+
- **Claude Code** users should read [CLAUDE.md](CLAUDE.md) for project guidance and workflow notes
8+
- **Other AI agents** should follow the same practices outlined in [CLAUDE.md](CLAUDE.md) unless a tool-specific guide is added later
9+
10+
## Important Notes
11+
12+
- When making changes, bump the project version in `pyproject.toml` and all `__version__` files (`backend/__init__.py`, `frontend/__init__.py`, `shared/__init__.py`, `proxy/__init__.py`)
13+
- Current version: **0.6.0**
14+
- See [CLAUDE.md](CLAUDE.md) for architecture overview, development commands, and recent changes
15+
- See [README.md](README.md) for user-facing documentation and quick start
16+
17+
## Documentation Structure
18+
19+
- **README.md** - User-facing documentation (installation, configuration, usage)
20+
- **CLAUDE.md** - Developer documentation (architecture, patterns, workflows)
21+
- **docs/** - Additional guides and technical references
22+
23+
## Version History
24+
25+
- **v0.6.0** (2025-12-29) - Performance improvements, compat provider auto-sync, API key support for all Ollama modes
26+
- See [CLAUDE.md - Recent Changes](CLAUDE.md#recent-changes--gotchas) for detailed changelog

0 commit comments

Comments
 (0)