From cffa73905612de988a0a695b9501faff2e7be2fc Mon Sep 17 00:00:00 2001 From: tonym Date: Tue, 16 Jun 2026 00:28:51 -0500 Subject: [PATCH] docs: add Animals module to README + CLAUDE.md Co-Authored-By: Claude Opus 4.8 (1M context) --- CLAUDE.md | 4 +++- README.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 21033d7..c804e8f 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -11,7 +11,9 @@ user-facing overview. **PlantType** records, Wikipedia photos. Plants sit on the shared location tree. - **Inventory** — durable **Item**s that nest (`parentItemId`), with **Label**s (M:N via `LabelOnItem`), `ItemAttachment`, and `ItemLog`. Shares the Location spine. -- **Locations** — `Location` tree (self-ref `parentId`) shared by plants + items. +- **Animals** — `Animal` + `AnimalLog` (pets/livestock); placed on the Location + tree, and `Task`s can link to an animal (`Task.animalId`). +- **Locations** — `Location` tree (self-ref `parentId`) shared by plants, items, animals. - **Reminders** — `Task` + `TaskCompletion`; recurrence in `src/lib/tasks/schedule.ts`. - **REST API** — `/api/v1/*` authed by `ApiToken` (per-scope; logic in `src/lib/api/`). - **Suggestions** — `@otm/account-panel` (Gitea npm registry) → files issues to the repo. diff --git a/README.md b/README.md index 6adc7ca..58b8657 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,10 @@ Live at **http://192.168.0.5:8053**. - **Inventory** — durable **items** that nest (boxes within rooms within buildings), with labels, attachments, and logs. Shares the same location spine as the garden. +- **Animals** — pets & livestock with their own logs, placed on the shared + location tree; reminders can be linked to an animal. - **Reminders** — one-off or recurring tasks (every N days / monthly / yearly), - optionally linked to a plant. + optionally linked to a plant or animal. - **REST API** (`/api/v1/*`) — personal access **tokens** with per-scope permissions (read plants, log harvests, …) for phone shortcuts, Home Assistant, and automation.