Merge remote-tracking branch 'lklynet/main' into feat/lru-cache

README.md

@@ -1,8 +1,7 @@
-<p align="center">
-  <img src="hypermind2.svg" width="150" alt="Hypermind Logo" />
-</p>
-
-# Hypermind
+<div align="center">
+<img src="hypermind2.svg" width="150" alt="Hypermind Logo" />
+<h1>Hypermind</h1>
+</div>
 
 ### The High-Availability Solution to a Problem That Doesn't Exist.
 
@@ -12,7 +11,7 @@ It solves the critical infrastructure challenge of knowing exactly how many othe
 
 ---
 
-## What is this?
+## » What is this?
 
 You have a server rack in your basement. You have 128GB of RAM. You have deployed the Arr stack, Home Assistant, Pi-hole, and a dashboard to monitor them all. **But you crave more.**
 
@@ -26,7 +25,7 @@ You need a service that:
 
 There is no central server. There is no database. There is only **The Swarm**.
 
-## How it works (The Over-Engineering)
+## » How it works
 
 We utilize the **Hyperswarm** DHT (Distributed Hash Table) to achieve a singular, trivial goal of **Counting.**
 
@@ -36,7 +35,7 @@ We utilize the **Hyperswarm** DHT (Distributed Hash Table) to achieve a singular
 
 If you turn your container off, you vanish from the count. If everyone turns it off, the network ceases to exist. If you turn it back on, you are the Creator of the Universe (Population: 1).
 
-## Deployment
+## » Deployment
 
 ### Docker (The Fast Way)
 
@@ -54,8 +53,6 @@ docker run -d \
 
 > **⚠️ CRITICAL NETWORK NOTE:**
 > Use `--network host`. This is a P2P application that needs to punch through NATs. If you bridge it, the DHT usually fails, and you will be the loneliest node in the multiverse.
->
-> If you need to change the port (default 3000), update the `PORT` environment variable. Since `--network host` is used, this port will be opened directly on the host.
 
 ### Docker Compose (The Classy Way)
 
@@ -73,14 +70,61 @@ services:
 
 ```
 
-## Environment Variables
+### Kubernetes (The Enterprise Way)
+
+For when you need your useless counter to be orchestrated by a control plane.
+
+```bash
+kubectl create deployment hypermind --image=ghcr.io/lklynet/hypermind:latest --port=3000
+kubectl set env deployment/hypermind PORT=3000
+kubectl expose deployment hypermind --type=LoadBalancer --port=3000 --target-port=3000
+
+```
+
+## » Ecosystem & Integrations
+
+The community has bravely stepped up to integrate Hypermind into critical monitoring infrastructure.
+
+### Home Assistant
+
+Do you want your living room lights to turn red when the swarm grows? Of course you do.
+
+The [Hypermind HA Integration](https://github.com/synssins/hypermind-ha) (installable via HACS) provides:
+
+* **RGB Control:** 0 nodes = Green. 10,000 nodes = Red.
+* **Sensors:** Swarm health checks and statistics logging.
+* **WLED Support:** Visualize the swarm size on a literal LED strip.
+
+### Homepage Dashboard
+
+If it's not on your dashboard, does it even exist? You can query the `/api/stats` endpoint to add a widget to [gethomepage/homepage](https://gethomepage.dev/).
+
+Add this to your `services.yaml`:
+
+```yaml
+- Hypermind:
+    icon: /icons/hypermind2.png
+    href: http://<YOUR_IP>:3000
+    widget:
+      type: customapi
+      url: http://<YOUR_IP>:3000/api/stats
+      method: GET
+      mappings:
+        - field: count
+          label: Swarm Size
+        - field: direct
+          label: Friends
+
+```
+
+## » Environment Variables
 
 | Variable | Default | Description |
-|----------|---------|-------------|
+| --- | --- | --- |
 | `PORT` | `3000` | The port the web dashboard listens on. Since `--network host` is used, this port opens directly on the host. |
 | `MAX_PEERS` | `10000` | Maximum number of peers to track in the swarm. Unless you're expecting the entire internet to join, the default is probably fine. |
 
-## Usage
+## » Usage
 
 Open your browser to: `http://localhost:3000`
 
@@ -91,7 +135,7 @@ The dashboard updates in **Realtime** via Server-Sent Events.
 * **Active Nodes:** The total number of people currently running this joke.
 * **Direct Connections:** The number of peers your node is actually holding hands with.
 
-## Local Development
+## » Local Development
 
 Want to contribute? Why? It already does nothing perfectly. But here is how anyway:
 
@@ -127,7 +171,7 @@ They should discover each other, and the number will become `2`. Dopamine achiev
 A: No. We respect your GPU too much.
 
 **Q: Does this store data?**
-A: No. It has the memory span of a goldfish (approx. 2.5 seconds).
+A: No. It has the short-term working memory of a honeybee (approx. 2.5 seconds). Which is biologically accurate and thematically consistent.
 
 **Q: Why did you make this?**
-A: The homelab must grow. ¯\\_(ツ)_/¯
+A: The homelab must grow. ¯\\_(ツ)_/¯