bonna61/Moonbase
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add Animals module to README + CLAUDE.md

Browse Source 
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Tony Moon
2026-06-16 00:28:51 -05:00
parent 39be24c2fc
commit cffa739056
2 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CLAUDE.md
View File

@@ -11,7 +11,9 @@ user-facing overview.
**PlantType** records, Wikipedia photos. Plants sit on the shared location tree. **PlantType** records, Wikipedia photos. Plants sit on the shared location tree.
- **Inventory** — durable **Item**s that nest (`parentItemId`), with **Label**s - **Inventory** — durable **Item**s that nest (`parentItemId`), with **Label**s
(M:N via `LabelOnItem`), `ItemAttachment`, and `ItemLog`. Shares the Location spine. (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`. - **Reminders** — `Task` + `TaskCompletion`; recurrence in `src/lib/tasks/schedule.ts`.
- **REST API** — `/api/v1/*` authed by `ApiToken` (per-scope; logic in `src/lib/api/`). - **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. - **Suggestions** — `@otm/account-panel` (Gitea npm registry) → files issues to the repo.

4
README.md
View File

@@ -15,8 +15,10 @@ Live at **http://192.168.0.5:8053**.
- **Inventory** — durable **items** that nest (boxes within rooms within - **Inventory** — durable **items** that nest (boxes within rooms within
buildings), with labels, attachments, and logs. Shares the same location spine buildings), with labels, attachments, and logs. Shares the same location spine
as the garden. 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), - **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 - **REST API** (`/api/v1/*`) — personal access **tokens** with per-scope
permissions (read plants, log harvests, …) for phone shortcuts, Home Assistant, permissions (read plants, log harvests, …) for phone shortcuts, Home Assistant,
and automation. and automation.