feat: add README.md

This commit is contained in:
Ricardo Arturo Cabral Mejia 2022-04-16 23:53:25 +00:00
parent a0e3d3e1da
commit 750bc1f985
No known key found for this signature in database
GPG Key ID: 5931EBF43A650245

38
README.md Normal file
View File

@ -0,0 +1,38 @@
# [nostr-ts-relay](https://github.com/Cameri/nostr-ts-relay)
This is a [nostr](https://github.com/fiatjaf/nostr) relay, written in
Typescript.
The project master repository is available on [GitHub](https://github.com/Cameri/nostr-ts-relay).
## Features
NIPs with a relay-specific implementation are listed here.
- [ ] NIP-01: Basic protocol flow description
- [ ] NIP-02: Contact list and petnames
- [ ] NIP-03: OpenTimestams Attestations for Events
- [ ] NIP-04: Encrypted Direct Message
- [ ] NIP-05: Mapping Nostr keys to DNS identifiers
- [ ] NIP-09: Event deletion
- [ ] NIP-11: Relay information document
- [ ] NIP-12: Generic tag queries
- [ ] NIP-13: Alias (_experimental_)
- [ ] NIP-14: Reputation scheme (_experimental_)
- [ ] NIP-15: Relating events to resources (_experimental_)
## Quick Start
TBD
## Configuration
TBD
## Dev Channel
For development discussions, please feel free to use the [Nostr Telegram Channel](https://t.me/nostr_protocol).
## License
This project is MIT licensed.