add protocol specification

README.md

@@ -0,0 +1,30 @@
+# Yonexus.Protocol
+
+This repository contains the **shared communication protocol specification** for the Yonexus system.
+
+It is referenced as a git submodule by both `Yonexus.Server` and `Yonexus.Client`.
+
+## Contents
+
+- `PROTOCOL.md` — full protocol specification
+- TypeScript type definitions (planned: `src/types.ts`)
+- Canonical JSON shape references
+
+## Purpose
+
+Yonexus is a cross-instance communication system for OpenClaw, split into:
+- `Yonexus.Server` — the central hub plugin
+- `Yonexus.Client` — the client plugin
+- `Yonexus.Protocol` — the shared protocol definition
+
+Both server and client implementations must conform to the protocol defined in this repository.
+
+## Version
+
+Current protocol version: **draft v0.3**
+
+## References
+
+- [Yonexus umbrella repository](https://git.hangman-lab.top/nav/Yonexus)
+- [Yonexus.Server](https://git.hangman-lab.top/nav/Yonexus.Server)
+- [Yonexus.Client](https://git.hangman-lab.top/nav/Yonexus.Client)