Replace generic template README with SCADA for Small Water Systems project description

README.md

@@ -1,48 +1,54 @@
-# {{PROJECT_NAME}}
+# SCADA for Small Water Systems
 
-**Project repository** for the Hermes AI Agent Development Team.
+**A modern, low-egress monitoring and alerting platform for small municipal and private water systems.**
 
-This repository was created from the `template-app` template.
+This repository contains the full system design, specifications, architecture, and implementation for an intelligent SCADA solution targeted at small water systems (typically < 1,000 connections). The system combines edge computing (Raspberry Pi), hybrid AI models, and a clean multi-tenant web interface to deliver reliable monitoring with minimal data transfer costs.
 
 ---
 
-## Purpose
+## Project Goals
 
-This repo is where actual development work happens. It contains the source code, tests, documentation, and project-specific task tracking for this application.
+- Provide affordable, professional-grade monitoring for small water systems that cannot justify traditional SCADA costs.
+- Minimize ongoing data egress costs through intelligent local processing and tiered telemetry.
+- Enable both non-technical board members and licensed operators to have appropriate visibility and control.
+- Build a foundation for proactive alerting, anomaly detection, and long-term system health insights using AI.
 
 ---
 
-## Agent Workflow in This Repo
+## Key Concepts
 
-1. High-level planning and architecture decisions are done in the `core-planning` repository.
+- **Monitored Objects**: First-class abstraction for pumps, filters, tanks, sensors, etc.
-2. Specific tasks for this project are tracked in the `/tasks` folder.
+- **Tiered Telemetry**: Immutable core signals + optional signals (full telemetry vs alert-only mode).
-3. All code changes go through Pull Requests.
+- **Hybrid AI Architecture**: Small edge models for local decisions + larger cloud models for complex reasoning.
-4. Agents follow the role instructions located in `/agents`.
+- **Low-Egress Design**: Heavy summarization locally, rich context only sent during alerts.
+- **Multi-Tenancy**: Supports both individual system owners and professional operators managing multiple systems.
 
 ---
 
 ## Repository Structure
 
+All project documentation lives under `/docs`:
+
 ```
-.
+docs/
-├── src/                    # Application source code
+├── vision.md
-├── tests/                  # Test files
+├── architecture/
-├── docs/                   # Project documentation
+├── specs/
-├── agents/                 # Agent role instructions for this project
+├── hardware/
-├── tasks/                  # Active and completed tasks
+├── decisions/          # Architecture Decision Records (ADRs)
-├── prompts/                # Project-specific prompts
+└── images/
-├── .gitea/                 # Issue and PR templates
-└── README.md
 ```
 
+Active development tasks are tracked in `/tasks`.
+
+Agent role definitions and swarm coordination live in `/agents` and follow the Hierarchical Agent (HA) methodology defined in this template.
+
 ---
 
-## Getting Started
+## Current Status
 
-- New features should begin with a task in `/tasks`
+This project is in the **early architecture and specification phase**. The core vision, use cases, and high-level system design are being finalized before moving into detailed implementation.
-- All changes require a Pull Request
-- Reference related issues from `core-planning` when relevant
 
 ---
 
-*Maintained by the Hermes AI Agent Team*
+*Maintained by Ty_Tech*