From 43fbee2b36b30665409ba85457257105b3ada7e6 Mon Sep 17 00:00:00 2001 From: Yonle Date: Sun, 19 May 2024 22:36:34 +0700 Subject: [PATCH] README: update explanation Signed-off-by: Yonle --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f072f26..9a50172 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,20 @@ A nostr relay bouncer. ## What is this? -**Bostr** is an nostr relay aggregator **proxy** that acts like a regular nostr relay. It connects to multiple configured relays to exchange data (events). +**Bostr** is an nostr relay aggregator **proxy** that acts like a regular nostr relay. It connects to multiple configured relays to exchange data (events). This project purpose is saving mobile user's bandwidth when using nostr. ## Why? Nostr relays is a bunch of dummy servers that store user events. Normally nostr clients connects to more than 5-10 relays to receive and transmit events. -Due to it's nature that connects to more than just a single relay, **Client bandwidth usage is high.** And because of this, Nostr bandwidth usage is not really recommended for some users, notably **mobile data users.** +Due to it's nature that connects to more than just a single relay, It's transmitting and retrieving the same event across relays over and over, Which then makes the **client bandwidth usage to be high.** And because of this, Nostr bandwidth usage is not really recommended for some users, notably **mobile data users.** -This project solve the problem by **reducing** the number of connected relays, at the same time **proxying** multiple relays in a single socket to nostr client. +This project solve the problem by **proxying** multiple relays in a single socket while **not forwarding the same event** to the client. ## How it works? ![How it works](img/how_it_works.png) +In order to make this work properly, A nostr client should only connect to a single bostr relay and no other. + ## Installation - [NodeJS](https://nodejs.org) (v18 or up) - A fast internet connection