Skip to content

Commit f7b2b01

Browse files
committed
relay-builder: update description
Closes #782 Signed-off-by: Yuki Kishimoto <[email protected]>
1 parent bb31377 commit f7b2b01

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

crates/nostr-relay-builder/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name = "nostr-relay-builder"
33
version = "0.39.0"
44
edition = "2021"
5-
description = "Nostr Relay Builder"
5+
description = "Build your own custom nostr relay!"
66
authors.workspace = true
77
homepage.workspace = true
88
repository.workspace = true

crates/nostr-relay-builder/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Nostr Relay Builder
22

3+
## Description
4+
5+
Build your own custom nostr relay!
6+
7+
This library contains all the stuff to easily build a nostr relay.
8+
It also contains a ready-to-use `MockRelay` for unit tests.
9+
310
## State
411

512
**This library is in an ALPHA state**, things that are implemented generally work but the API will change in breaking ways.

0 commit comments

Comments
 (0)