Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add readme file #1

Merged
merged 1 commit into from
Aug 27, 2024
Merged

add readme file #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
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.