Separate active YAMN code from Katzenpost PoC

1 files changed, 22 insertions, 0 deletions

diff --git a/nym/README.md b/nym/README.md
new file mode 100644
index 0000000..0cd4f10
--- /dev/null
+++ b/nym/README.md
@@ -0,0 +1,22 @@
+# YAMN Nym sender
+
+This binary sends an already encrypted YAMN envelope through the Nym mixnet
+using the Rust SDK. It is intentionally send-only: it does not receive
+messages, expose replies, fetch remailer data, or perform YAMN encoding.
+
+Configuration is supplied through the environment:
+
+- `YAMN_NYM_RECIPIENT`: fixed Nym address of the YAMN ingress service.
+- `YAMN_ENTRY_ADDRESS`: exact allowlisted YAMN entry address used by the ingress.
+- `YAMN_NYM_STORAGE`: persistent client storage directory. Defaults to
+  `/var/lib/yamnweb/nym-client`.
+
+The request is one JSON object on standard input:
+
+```json
+{"entry_address":"yamn@example.org","payload":"<raw encrypted YAMN SMTP envelope>"}
+```
+
+The binary never logs the request or its contents. The Nym recipient must be
+an ingress service that knows how to hand the envelope to YAMN. A normal SMTP
+address is not a valid replacement for `YAMN_NYM_RECIPIENT`.