diff options
Diffstat (limited to 'yamn/README.md')
| -rw-r--r-- | yamn/README.md | 14 |
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. |