docs

README.md

@@ -13,7 +13,7 @@ A reactive, interactive dog breeding genealogy mapping system for professional k
 
 ## 🚀 Quick Start
 
-### Docker Deployment (Recommended)
+### 1. Docker Deployment (Recommended)
 ```bash
 git clone https://git.alwisp.com/jason/breedr.git
 cd breedr
@@ -21,36 +21,33 @@ docker-compose up -d --build
 ```
 Access at: `http://localhost:3000`
 
-### Local Development
+### 2. Manual Development Setup
 ```bash
 npm install
 npm run dev
 ```
+> **Note:** The database initializes automatically on first boot. No manual migrations are required.
 
 ---
 
-## ✅ Core Features
+## 🐕 Managing Your Kennel
 
-### 🐕 Dog & Litter Management
-- **Registry**: Complete CRUD operations for your kennel.
-- **Photo Management**: Multiple high-quality photos per dog.
-- **Litter Tracking**: Link puppies to breeding records automatically.
-- **Champion Tracking**: Badge titled dogs; titles pass "Champion Bloodline" status to offspring.
+- **Adding Dogs**: Go to the **Dogs** page, click **Add New Dog**. You can mark dogs as **External** if they aren't in your kennel but are needed for pedigree mapping.
+- **Champion Tracking**: Toggle the **Champion** status to title dogs. Offspring will automatically display the "Champion Bloodline" badge.
+- **Photo Management**: Multiple high-quality photos per dog with a compact gallery view.
+- **Litter Tracking**: Link puppies to breeding records automatically to track weight and health from birth.
 
-### 🧬 Breeding & Genetics
-- **Interactive Pedigree**: Multi-generational trees with zoom/pan and reverse (descendant) toggles.
-- **Trial Pairing**: Simulator with **COI calculation**, common ancestor identification, and risk badges.
-- **Heat Cycles**: Full calendar with phase tracking, breeding windows, and **projected whelping alerts**.
+## 🧬 Breeding & Genetics
 
-### ⚙️ Kennel Configuration
-- **Settings System**: Centralized management for kennel name, branding, and contact info.
-- **Branding**: Custom logo support and professional dark-themed UI with glassmorphism.
+- **Interactive Pedigree**: 5-generation trees with zoom/pan. Toggle the **Reverse Pedigree** switch to see descendant lineage.
+- **Trial Pairing Simulator**: Calculate Wright's Inbreeding Coefficient (COI) instantly. Identifies common ancestors and providing risk badges (Low/Moderate/High).
+- **Heat Cycles**: Track female cycles on the calendar. Includes **projected whelping alerts** (indigo windows) and expected due dates.
 
 ---
 
 ## 🛠️ Technology Stack
 - **Frontend**: React 18, Vite, Lucide Icons
-- **Visualization**: React-D3-Tree
+- **Visualization**: React-D3-Tree, D3.js
 - **Backend**: Node.js, Express.js
 - **Database**: SQLite (Zero-config, safe `ALTER TABLE` migrations)
 - **Deployment**: Multi-stage Docker
@@ -65,7 +62,7 @@ breedr/
 ├── static/                 # Branded assets (logos, etc.)
 ├── data/                   # SQLite database storage (mapped in Docker)
 ├── uploads/                # Dog photo storage (mapped in Docker)
-└── ROADMAP.md              # Detailed development history & planned features
+└── docs/                   # Technical documentation and design history
 ```
 
 ---
@@ -76,15 +73,15 @@ breedr/
 - **v0.7.0** (In Progress): Health & Genetics (OFA clearances, DNA panels).
 - **v0.6.1**: COI calculation fix for direct parent×offspring relations.
 - **v0.6.0**: Champion status tracking & Kennel settings API.
-- **v0.5.1**: Projected whelping windows and calendar identifiers.
-- **v0.5.0**: Breeding tools, pairing simulator, and heat cycle calendar.
 
 ---
 
 ## ❓ Troubleshooting
-- **COI shows 0.00%?**: Ensure you are on v0.6.1+ to fix direct-relation pathing.
-- **Missing Columns?**: Restart the server; safe migration guards add columns automatically.
+- **COI shows 0.00%?**: Ensure both parents are mapped and have shared ancestors.
+- **Missing Columns?**: Restart the server; auto-init guards add columns automatically.
 - **Logo not appearing?**: Place `br-logo.png` in the `static/` directory.
 
 ---
-**Full Documentation & Roadmap**: [ROADMAP.md](ROADMAP.md) | [DATABASE.md](DATABASE.md)
+
+**Full Documentation**:
+[Installation Guide](INSTALL.md) | [Development & Architecture](DEVELOPMENT.md) | [API Reference](API.md) | [Roadmap](ROADMAP.md)