docs: concise update to README to match project template

Co-authored-by: Zakary Timson
2026-09-21 14:21:06 -04:00
parent 1d46364ebb
commit 42472a85ce
1 changed files with 51 additions and 68 deletions
@@ -1,73 +1,56 @@
 # Multipurpose Radio Server (MRS)

-**Multipurpose Radio Server** is an offline-first connectivity and reconnaissance hub designed for isolated environments.
-
-> Compact communication and information exchange server on Raspberry Pi for service-denied areas. Ideal for disasters, unserviced environments, long-range tracking, and offline-first operations.
-
-## Overview
-
-MRS provides a modular, hardware-focused foundation that interfaces with three supporting layers:
-
- **MRS Core Layer**: Connectivity, radio, and reconnaissance tools
- **OpenCast Layer**: Media casting, control panel, and remote desktop
- **AI-harness Layer**: AI assistant, knowledge base, and file services
-
-## Core Capabilities
-
-### Connectivity
- 900 MHz HaLow / 2.4 & 5 GHz mesh WiFi via B.A.T.M.A.N.
- LoRa radio communication via Meshtastic node
- QR-code connection setup with captive portal
-
-### Hardware Interface
- Live data visualization to connected TV/display
- Meshtastic LoRa node for field tracking
- Spectrum analysis via SDRAngel
-
-### Reconnaissance & Security
- WiFi/Bluetooth scanning (Bettercap, nmap, masscan)
- Radio frequency recon (SDRAngel)
- ADS-B plane tracking (tar1090)
- Red team toolkit (aircrack, nikto, Metasploit)
-
-## Features
-
- **Connectivity**: Mesh networking for 1 km+ coverage
- **Archive**: Kiwix offline Wikipedia and knowledge base
- **Recon Tools**: Network and radio frequency scanning suite
- **Messaging**: Federated chat via Synapse/Element (legacy support)
- **Remote Desktop**: VNC integration via OpenCast backend
-
-## Installation
-
-```bash
-git clone https://git.zakscode.com/ztimson/mrs
-cd mrs
-npm ci
-```
-
- MRS core: port 8088
- OpenCast: port 3000
- AI-harness: port 3001
-
-## Documentation
-
- [Setup Guide](docs/setup.md)
- [Mesh Network](docs/mesh.md)
- [Maps & Geolocation](docs/maps.md)
-
-## Todo
-
- [ ] API contracts between layers
- [ ] Telemetry endpoint
- [ ] OTA update mechanism
-
-## License
-
-[MIT License](LICENSE).
-
 ---

 ###### By: Zakary Timson
-###### Date: September 16, 2025
+###### Date: September 2026
 ###### Version: 1.0
+
+---
+
+> Compact communication and information exchange server for service-denied areas. Ideal for disaster response, long-range tracking, and offline-first operations.
+
+---
+
+## 🗂️ Capabilities
+
+**Networking:**
+*   900 MHz HaLow / 2.4/5 GHz Mesh WiFi (B.A.T.M.A.N.)
+*   LoRa radio communication (Meshtastic node)
+*   Captive portal & device home page setup
+
+**Communication:**
+*   Offline federated chat (Synapse/Element)
+*   GPS positioning & offline maps
+
+**Tools & Integration:**
+*   **AI Assistant**: Powered by the custom **AI-Harness** (Gemma4-e2b)
+*   **Knowledge Base**: Offline access via **Kiwix** (Harness provided)
+*   **Reconnaissance**: Bettercap, nmap, aircrack, Metasploit, and SDRAngel
+*   **Media/Control**: Control and casting interface provided by **OpenCast**
+*   **Remote Access**: VNC built into the **OpenCast** layer
+
+---
+
+## 🛠️ Technical Focus
+
+MRS acts as the hardware and recon core. All features are unified through the OpenCast control panel and the AI-Harness layer.
+
+## 🚀 Quick Start
+
+```bash
+# Clone and install
+git clone https://git.zakscode.com/ztimson/mrs
+cd mrs
+
+# Install base dependencies
+npm ci
+
+# Start core services
+```
+
+---
+
+## 📜 License
+
+This project is licensed under the MIT License.