From 44dcc22a043c86d7d3f58e10ebafee40b0b301b4 Mon Sep 17 00:00:00 2001 From: mplorentz Date: Thu, 10 Sep 2026 10:23:40 -0400 Subject: [PATCH] Minor readme edits --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4f6f479..1ffaaa0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Mailship -A Nostr email notification server. Receives events pushed from relays via NIP-9a, stores them, and sends daily or weekly digest emails. +A Nostr email notification server. Receives events pushed from relays via [NIP-9a](), stores them, and sends daily or weekly digest emails. + +This repo is a fork of [anchor](https://github.com/coracle-social/anchor). It has been built primarily to support email notifications in [Flotilla](https://flotilla.social), but supports alternate branding and could be set up to work with any Nostr relay supporting NIP-9a. ## Architecture @@ -55,8 +57,7 @@ Response: { key, callback } ``` ### GET /subscription/email?pubkey=... -Look up an existing subscription, so clients can avoid re-registering (and -re-confirming) when settings haven't changed. Returns 404 if none exists. +Look up an existing subscription. Returns 404 if none exists. ``` Response: { key, callback, email, frequency, confirmed } @@ -129,8 +130,4 @@ docker run -d \ ```sh pnpm test # Run integration tests pnpm test:server # Start server for manual testing -``` - -## Forked from Anchor - -Mailship is a fork of [Anchor](https://github.com/coracle-social/anchor), stripped of push notification support and adapted for NIP-9a relay push event intake. \ No newline at end of file +``` \ No newline at end of file