matt/mailship
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor readme edits

Browse source
This commit is contained in:
mplorentz 2026-09-10 10:23:40 -04:00
parent d5f54845b6
commit 44dcc22a04
1 changed files with 5 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,6 +1,8 @@
# Mailship # 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 ## Architecture
@ -55,8 +57,7 @@ Response: { key, callback }
``` ```
### GET /subscription/email?pubkey=... ### GET /subscription/email?pubkey=...
Look up an existing subscription, so clients can avoid re-registering (and Look up an existing subscription. Returns 404 if none exists.
re-confirming) when settings haven't changed. Returns 404 if none exists.
``` ```
Response: { key, callback, email, frequency, confirmed } Response: { key, callback, email, frequency, confirmed }
@ -129,8 +130,4 @@ docker run -d \
```sh ```sh
pnpm test # Run integration tests pnpm test # Run integration tests
pnpm test:server # Start server for manual testing 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.