init

docs/README.md

@@ -0,0 +1,29 @@
+# NetworkCore Docs
+
+NetworkCore is the foundational plugin every other KweebecNet plugin depends on. It owns metrics, cross-server messaging, and the server-discovery layer.
+
+If you're building a plugin that needs to talk to other servers, record stats, or know who else is online, you depend on this.
+
+## Reading order
+
+1. [01_Overview.md](01_Overview.md) - what NetworkCore actually does and why it exists
+2. [02_Plugin_Integration.md](02_Plugin_Integration.md) - how another plugin depends on it and gets a reference
+3. [03_Configuration.md](03_Configuration.md) - config.json + env vars
+4. [04_Metrics.md](04_Metrics.md) - MetricsService API and the Prometheus endpoint
+5. [05_MessageBus.md](05_MessageBus.md) - Redis pub/sub for cross-server events
+6. [06_ServerRegistry.md](06_ServerRegistry.md) - discovery and presence events
+7. [07_RPC.md](07_RPC.md) - request/response between servers
+8. [08_Commands.md](08_Commands.md) - the /networkcore admin command
+9. [09_Operations_And_Security.md](09_Operations_And_Security.md) - auth token, what's not secured, ops checks
+
+## Quick reference
+
+| Thing | Class |
+|---|---|
+| Plugin entry | [NetworkCore](../src/main/java/net/kewwbec/networkcore/NetworkCore.java) |
+| Singleton | `NetworkCore.getInstance()` |
+| Manifest dependency string | `kewwbec:NetworkCore` |
+| Default Redis | `127.0.0.1:6379` |
+| Default Prometheus endpoint | `http://127.0.0.1:9100/metrics` |
+| Auth env var | `NETWORK_AUTH_TOKEN` |
+| Redis password env var | `REDIS_PASSWORD` |