nostrrelay/README.md
2023-02-16 16:30:30 +02:00

26 lines
843 B
Markdown

# Nostr Relay
## One click and spin up your own Nostr relay. Share with the world, or use privately.
### Usage
Install this extension into your LNbits instance.
....
## Supported NIPs
- [x] **NIP-01**: Basic protocol flow
- [x] **NIP-02**: Contact List and Petnames
- `kind: 3`: delete past contact lists as soon as the relay receives a new one
- [ ] **NIP-04**: Encrypted Direct Message
- todo: if auth: do not broadcast, send only to the intended target
- [x] **NIP-09**: Event Deletion
- [x] **NIP-11**: Relay Information Document
- >**Note**: the endpoint is NOT on the root level of the domain. It also includes a path (eg https://lnbits.link/nostrrelay/)
### Development
Create Symbolic Link:
```
ln -s /Users/my-user/git-repos/nostr-relay-extension/ /Users/my-user/git-repos/lnbits/lnbits/extensions/nostrrelay
```