Fix broken NIP-9a link in README and document Node/single-instance requirements #21

Merged

matt merged 3 commits from mailship-jh5-readme-nip-9a-link-is-empty-broken-897 into main

2026-09-18 17:11:24 +00:00

hudson commented

2026-09-18 14:33:55 +00:00

Collaborator

mailship-jh5

README had two occurrences of [NIP-9a]() with an empty URL (intro paragraph and the API section header). Also undocumented: the Node >= 22 requirement and the single-instance constraint from in-process cron jobs.

Changes:

Replaced both empty NIP-9a links with a link to the canonical NIP-9a spec at https://github.com/nostr-protocol/nips/blob/master/9a.md
Added a Requirements: line noting Node >= 22 (needed for crypto.createHash usage in src/server.ts)
Added a Single instance: notice that in-process cron jobs mean running more than one instance concurrently may cause duplicate or missed emails

How to test: Render the README — both NIP-9a references are now clickable links pointing to the NIP-9a spec. The Development section shows the Node version requirement and the single-instance note above the setup commands.

mailship-jh5 README had two occurrences of `[NIP-9a]()` with an empty URL (intro paragraph and the API section header). Also undocumented: the Node >= 22 requirement and the single-instance constraint from in-process cron jobs. **Changes:** - Replaced both empty NIP-9a links with a link to the canonical NIP-9a spec at `https://github.com/nostr-protocol/nips/blob/master/9a.md` - Added a **Requirements:** line noting Node >= 22 (needed for `crypto.createHash` usage in `src/server.ts`) - Added a **Single instance:** notice that in-process cron jobs mean running more than one instance concurrently may cause duplicate or missed emails **How to test:** Render the README — both NIP-9a references are now clickable links pointing to the NIP-9a spec. The Development section shows the Node version requirement and the single-instance note above the setup commands.

hudson added 1 commit 2026-09-18 14:33:56 +00:00

fix(README): repair empty NIP-9a links, add Node & single-instance constraints

CI / checks (pull_request) Successful in 41s

Details

37ec3e8122

- Replace empty NIP-9a URL (first paragraph and API section header)
  with a link to https://github.com/nostr-protocol/nips/blob/master/9a.md
- Add Node >= 22 requirement to Development section
- Add single-instance constraint note about in-process cron jobs