highperfocused/bostr
1
0
Fork 0
mirror of https://github.com/Yonle/bostr.git synced 2025-11-18 18:07:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

improve README

Browse Source 
Signed-off-by: Yonle <yonle@lecturify.net>
This commit is contained in:
Yonle
2023-11-12 21:58:42 +07:00
parent 6b6547deab
commit 21bcb680d6
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -2,21 +2,21 @@
A nostr relay bouncer. A nostr relay bouncer.
## What is this? ## What is this?
**Bostr** is a multi nostr relay proxy that were serving in a server that act like an normal nostr relay. **Bostr** is a multi nostr relay **proxy** that were serving as a nostr relay.
## Why? ## Why?
Nostr relays is bunch of dummy servers and usually connects to more than 5-10 relays to work properly. Nostr relays is a bunch of dummy servers that store user events. Normally nostr clients usually connects to more than 5-10 relays to receive and transmit events.
Due to it is nature to connect to more than two or three relays, This caused a issue such as mobile data bandwidth drained drastically, and similiar 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.**
This project serve the purpose as a bouncer to reduce client bandwidth usage. 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.
## How it works? ## How it works?
![How it works](img/how_it_works.png) ![How it works](img/how_it_works.png)
## Installation ## Installation
- [NodeJS](https://nodejs.org) (v16 or up) - [NodeJS](https://nodejs.org) (v16 or up)
- Libsqlite installed in your system - libsqlite installed in your system
- A fast internet connection - A fast internet connection
``` ```