Skip to content

Commit 5a09a35

Browse files
committed
docs : update
1 parent 7b3189d commit 5a09a35

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11
# webConnect.js
2-
📶 Auto WebRTC peer-to-peer connection
2+
📶 Auto WebRTC Mesh P2P Connection
33

44
[![npm version](https://badge.fury.io/js/webconnect.svg)](https://www.npmjs.com/package/webconnect)
55

66
Demo : [https://nuzulul.github.io/webConnect.js/demo/](https://nuzulul.github.io/webConnect.js/demo/)
77

8+
![webConnect.js](webconnectjs.png)
9+
810
## Why?
911

1012
I got tired of building and maintenance signaling server for my WebRTC projects
1113

1214
## How it works?
1315

14-
A direct browser to browser connection for static client side web application is normally impossible. Currently, the solution available was using WebRTC transport, which still required to setup a signaling server as a middleman. This library works by leveraging already established public protocol, such as Torrent, MQTT and NOSTR for signaling, eliminating the need for backend servers forever. Now static client side web application can talk to each other, even hosts on static hosting such as github pages, cloudflare pages, gitlab pages, netlify or any other static hosting even on local host.
16+
A direct browser to browser connection for static client side web application is normally impossible. Currently, the solution available was using WebRTC transport, which still required to setup a signaling server as a middleman. webConnect.js can create auto WebRTC mesh peer-to-peer connection without any hassle. This library works by leveraging already established public protocol, such as Torrent, MQTT and NOSTR for signaling, eliminating the need for backend servers forever. Now static client side web application can talk to each other, even hosts on static hosting such as github pages, cloudflare pages, gitlab pages, netlify or any other static hosting you name it even on local host.
1517

1618
## Features
1719

18-
* ✅ Auto p2p WebRTC connection
20+
* ✅ Auto WebRTC mesh p2p connection
1921
* ✅ Zero configuration for local network connection
2022

2123
## Installation
@@ -249,6 +251,10 @@ Ping(attribute)
249251
Disconnect()
250252
```
251253

254+
## Related
255+
256+
- [WebPEER](https://github.com/nuzulul/webpeerjs) - WebPEER is a novel decentralized P2P network overlay inside browser with a chance of working.
257+
- [RingsNetwork](https://github.com/RingsNetwork/rings) - Rings is a structured peer-to-peer network implementation using WebRTC, Chord DHT, and full WebAssembly (WASM) support.
252258

253259
## License
254260

webconnectjs.png

214 KB
Loading

0 commit comments

Comments
 (0)