Skip to content

Commit

Permalink
Merge pull request #1 from sepehr-safari/readme
Browse files Browse the repository at this point in the history
add readme file
  • Loading branch information
max21dev authored Aug 27, 2024
2 parents 044a9ee + 9bda410 commit 505168d
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 505168d

Please sign in to comment.