From 750bc1f985a4bd752866284bc374c2e4a4f1b3be Mon Sep 17 00:00:00 2001 From: Ricardo Arturo Cabral Mejia Date: Sat, 16 Apr 2022 23:53:25 +0000 Subject: [PATCH] feat: add README.md --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..04333a5 --- /dev/null +++ b/README.md @@ -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.