From 994071243fc80990cf09e820b671006e9bd31c76 Mon Sep 17 00:00:00 2001
From: Gab <24553253+gabrix73@users.noreply.github.com>
Date: Thu, 13 Aug 2026 14:04:30 +0200
Subject: Separate active YAMN code from Katzenpost PoC

---
 yamn/README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 yamn/README.md

(limited to 'yamn/README.md')

diff --git a/yamn/README.md b/yamn/README.md
new file mode 100644
index 0000000..24ce452
--- /dev/null
+++ b/yamn/README.md
@@ -0,0 +1,14 @@
+# YAMN encoder
+
+This module contains the active YAMN v2 encoder used by Yamnweb. It creates
+the encrypted YAMN envelope locally and does not perform network transport.
+
+Build and test it from this directory:
+
+```bash
+GOCACHE=/tmp/yamnweb-go-build go test ./...
+go build -o /usr/local/bin/yamn-encode ./cmd/yamn-encode
+```
+
+The Katzenpost standby proof of concept is maintained separately in the
+top-level `katzenpost/` module.
-- 
cgit v1.2.3