tribes/parrhesia
1
0
Fork 0
Code Issues Pull Requests Actions Releases 1 Activity

docs: README intro
Some checks failed
CI / Test (OTP 27.2 / Elixir 1.18.2) (push) Failing after 1s
Details
CI / Test (OTP 28.4 / Elixir 1.19.4 + Marmot E2E) (push) Failing after 1s
Details

Browse Source
This commit is contained in:
Steffen
2026-03-16 20:31:21 +01:00
parent d119d21d99
commit 987415d80c
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -4,7 +4,15 @@
Parrhesia is a Nostr relay server written in Elixir/OTP with PostgreSQL storage. Parrhesia is a Nostr relay server written in Elixir/OTP with PostgreSQL storage.
**ALPHA CONDITION – BREAKING CHANGES MIGHT HAPPEN!**
- Advanced Querying: Full-text search (NIP-50) and COUNT queries (NIP-45).
- Secure Messaging: First-class support for Marmot MLS-encrypted groups and NIP-17/44/59 gift-wrapped DMs.
- Identity & Auth: NIP-42 authentication flows and NIP-86 management API with NIP-98 HTTP auth.
- Data Integrity: Negentropy-based synchronization and NIP-62 vanish flows.
It exposes: It exposes:
- a WebSocket relay endpoint at `/relay` - a WebSocket relay endpoint at `/relay`
- NIP-11 relay info on `GET /relay` with `Accept: application/nostr+json` - NIP-11 relay info on `GET /relay` with `Accept: application/nostr+json`
- operational HTTP endpoints (`/health`, `/ready`, `/metrics`) - operational HTTP endpoints (`/health`, `/ready`, `/metrics`)