diff --git a/README.md b/README.md new file mode 100644 index 0000000..d842715 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# NIP-29 Group Chat Relay + +This is a relay implementation based on fiatjaf's [Relay29](https://github.com/fiatjaf/relay29) and [Khatru](https://github.com/fiatjaf/khatru). + +## Usage + +This project is a part of [nip29.com](https://nip29.com) project and has been designed to be used with the [Groups](https://groups.nip29.com) chat client. You may also use this relay in any group chat client that supports the [NIP-29](https://github.com/nostr-protocol/nips/blob/master/29.md) by connecting to the following WebSocket URL: + +``` +wss://relay.groups.nip29.com +``` + +## Self-hosting + +You can also self-host this relay implementation on your own server. + +## License + +This is an open-source project licensed under the MIT License.