summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 31 insertions, 4 deletions
diff --git a/README.md b/README.md
index 1cbaf8f..dd4aca0 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,39 @@
-# Tor before Yamn Anonymous Remailers Network Gateway
+# YAMN Anonymous Remailers Network Gateway
![Status](https://img.shields.io/badge/status-operational-green)
![Security](https://img.shields.io/badge/security-hardened-red)
-![Tor](https://img.shields.io/badge/tor-mandatory-purple)
+![Transport](https://img.shields.io/badge/transport-Nym-blueviolet)
![License](https://img.shields.io/badge/license-MIT-blue)
-A hardened web interface for [YAMN (Yet Another Mix Network)](https://github.com/crooks/yamn) implementing military-grade operational security with mandatory Tor routing and zero metadata retention.
+A hardened web interface for [YAMN (Yet Another Mix Network)](https://github.com/crooks/yamn). The active message transport uses a local Rust sender built with the Nym SDK. Tor is retained only for downloading remailer statistics and public key material.
+
+## Current active path
+
+```text
+Browser -> PHP yamnweb -> Rust yamn-nym-submit -> Nym ingress service -> YAMN
+ ^
+ |
+ already encrypted YAMN envelope only
+```
+
+The Nym sender is send-only and receives only an already encrypted envelope.
+`YAMN_NYM_RECIPIENT` must identify a Nym ingress service that knows how to
+forward the envelope to YAMN. A normal SMTP address is not a valid replacement.
+The active YAMN encoder is maintained in `yamn/`. Katzenpost remains in
+`katzenpost/` as a separate standby PoC and is not on the active path.
+
+The YAMN encoder is built from `yamn/`:
+
+```bash
+cd yamn
+GOCACHE=/tmp/yamnweb-go-build go test ./...
+go build -o /usr/local/bin/yamn-encode ./cmd/yamn-encode
+```
+
+The PHP deployment must set `YAMN_ENCODER` and `YAMN_PUBRING`. The keyring is
+read locally and the encoder emits the standard YAMN armored envelope.
+
+The legacy Tor sending instructions below are retained as historical reference.
## 🎯 Mission Statement
@@ -757,4 +785,3 @@ Contributions welcome! Please:
---
**Status:** ✅ Operational | **Last Updated:** October 2025 | **Version:** 2.0
-