From 44b2bffb7228d6005a3d1cc391a240701d7f776f Mon Sep 17 00:00:00 2001 From: spacebear Date: Mon, 9 Mar 2026 14:10:53 -0400 Subject: [PATCH] Update mailroom README description Use the landing page copy to better describe the two server-side roles bundled by payjoin-mailroom, and drop the now-broken links to payjoin-directory and ohttp-relay. --- payjoin-mailroom/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/payjoin-mailroom/README.md b/payjoin-mailroom/README.md index 7955ee7fb..8f92053e7 100644 --- a/payjoin-mailroom/README.md +++ b/payjoin-mailroom/README.md @@ -1,6 +1,9 @@ # Payjoin Mailroom -The Payjoin Mailroom is a unified Payjoin Directory and OHTTP Relay server. Combines [payjoin-directory](../payjoin-directory/README.md) and [ohttp-relay](../ohttp-relay/README.md) into a single binary. +payjoin-mailroom is a single, lightweight binary that bundles the two server-side roles required by BIP 77 Async Payjoin: + +- **Payjoin Directory**: a store-and-forward mailbox that holds small, ephemeral, end-to-end encrypted payloads so a sender and receiver can complete a payjoin asynchronously (they don't need to be online at the same time). +- **OHTTP Relay**: an [Oblivious HTTP](https://en.wikipedia.org/wiki/Oblivious_HTTP) proxy that separates client IP addresses from the directory, preventing the directory from correlating users with their network identity. Note that this binary is under active development and thus the CLI and configuration file may be unstable.