Skip to content

Commit

Permalink
docs : update add ideas
Browse files Browse the repository at this point in the history
  • Loading branch information
nuzulul committed Oct 11, 2024
1 parent 3fbe416 commit bf717d8
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# WebPEER
> Decentralized P2P network overlay inside browser
[WebPEER.js](https://github.com/nuzulul/webpeerjs) enables browser to browser connectivity without a central server. Build completely peer-to-peer web applications, no trackers or relay servers required. Connecting projects safely, privately, and reliably in WebPEER Network.
[WebPEERjs](https://github.com/nuzulul/webpeerjs) library enables browser to browser connectivity without a central server. Instant build completely peer-to-peer network embeded in your web applications, no trackers or relay servers required. Connecting projects safely, privately, and reliably in the global WebPEER Network.

Basic Connection Demo available at : [https://nuzulul.github.io/webpeerjs/demo/](https://nuzulul.github.io/webpeerjs/demo/)

Expand All @@ -22,6 +22,27 @@ WebPEER Network run over [`libp2p gossipsub`](https://docs.libp2p.io/concepts/se
* ✅ Broadcast Messages
* ✅ Censorship Resistant

## Ideas

* Blockchain
* Voting / Polling
* Collaborative activity
* IoT
* Censorship resistent social media
* Remote control
* Multiplayer games
* Decentralized/distributed web
* Signalling protocol
* Location tracker
* User activity tracker.

## Try it out!

* Go to a deployed chat demo at : [https://nuzulul.github.io/webpeerjs/demo/chat.html](https://nuzulul.github.io/webpeerjs/demo/chat.html) .
* Open the app on another device.
* Both your devices should connected.
* Now start sending message.

## Browser Support
![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![Opera](https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png) | ![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![Brave](https://raw.github.com/alrra/browser-logos/master/src/brave/brave_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/src/safari/safari_48x48.png) |
--- | --- | --- | --- | --- | --- |
Expand Down Expand Up @@ -81,8 +102,8 @@ void async function main() {
- `id` - Get the unique ID of the node as an identity in the global network.
- `status` - Get the node status, returns `connected` or `unconnected`.
- `peers` - Get all connected peers.
- `joinRoom(namespace)` - Join to the room, returns an array of three functions (Broadcaster, onListenBroadcast, onMembersUpdate).
- `Broadcaster` - Function to broadcast message to room members (limited to 1 message/second).
- `joinRoom(namespace)` - Join to the room, returns an array of three functions, example : [Broadcaster, onListenBroadcast, onMembersUpdate].
- `Broadcaster` - Function to broadcast message to room members (limited to 1 message/second as anti DOS mitigation).
- `onListenBroadcast` - Callback function that listen on incoming broadcast message.
- `onMembersUpdate` - Callback function that listen on room members update.

Expand Down

0 comments on commit bf717d8

Please sign in to comment.