summaryrefslogtreecommitdiffstats
path: root/yamn/README.md
diff options
context:
space:
mode:
authorGab <24553253+gabrix73@users.noreply.github.com>2026-08-13 14:04:30 +0200
committerGab <24553253+gabrix73@users.noreply.github.com>2026-08-13 14:04:30 +0200
commit994071243fc80990cf09e820b671006e9bd31c76 (patch)
treeb65e02724b98033240aa6f9d153acea021abc456 /yamn/README.md
parent47d903de3bca4165e96d6ec8830eafbacf524cd2 (diff)
downloadyamnweb-994071243fc80990cf09e820b671006e9bd31c76.tar.gz
yamnweb-994071243fc80990cf09e820b671006e9bd31c76.tar.xz
yamnweb-994071243fc80990cf09e820b671006e9bd31c76.zip
Separate active YAMN code from Katzenpost PoC
Diffstat (limited to 'yamn/README.md')
-rw-r--r--yamn/README.md14
1 files changed, 14 insertions, 0 deletions
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.