webpeerjs 0.0.8 → 0.0.10

package/README.md

@@ -1,14 +1,16 @@
 # WebpeerJS
-> Simple peer-to-peer with [IPFS](https://ipfs.tech/). Build completely P2P web applications, no trackers or relay servers involved.
+> Simple peer-to-peer in the browser.
 
-WebpeerJS enables browser to browser connectivity without a central server.
+Build completely P2P web applications, no trackers or relay servers required. [WebpeerJS](https://github.com/nuzulul/webpeerjs) enables browser to browser connectivity without a central server. Connecting people safely, privately, openly and reliably.
 
 [Live Demo](https://nuzulul.github.io/webpeerjs/demo/)
 
 ## Features
 
 * ✅ Decentralized Network
-* ✅ Broadcast Message
+* ✅ Unlimited Peers
+* ✅ Works in The Browser
+* ✅ Broadcast Message / Room
 
 ## Install
 
@@ -18,7 +20,9 @@ NPM :
 npm i webpeerjs
 ```
 
-CDN :
+Browser `<script>` tag :
+
+Uses built-in JS files from [latest release](https://github.com/nuzulul/webpeerjs/releases/latest) or [CDN](https://www.jsdelivr.com/package/npm/webpeerjs) will make it's exports available as `webpeerjs` in the global namespace.
 
 ```
 <script src="https://cdn.jsdelivr.net/npm/webpeerjs@0.0/dist/umd/webpeerjs.min.js"></script>
@@ -35,7 +39,7 @@ void async function main() {
 	
 	console.log(`My node id : ${node.id}`)
 	
-	const [broadcast,listen,members] = node.joinRoom('myroom')
+	const [broadcast,listen,members] = node.joinRoom('globalroom')
 	
 	listen((message,id) => {
 		console.log(`Message from ${id} : ${message}`)
@@ -53,9 +57,13 @@ void async function main() {
 
 - `createWebpeer()` Create a new node.
 - `id` The unique ID of the node as an identity in the global network.
-- `joinRoom()` Adding the node to the room, returns an array of three functions (Broadcaster, onListenMessage, onMembersUpdate).
-- `peers` Get all connected peers.
 - `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).
+
+## API Docs
+
+[https://nuzulul.github.io/webpeerjs](https://nuzulul.github.io/webpeerjs)
 
 ## Related
 
@@ -63,6 +71,11 @@ void async function main() {
 - [peerjs](https://github.com/peers/peerjs) - Simple peer-to-peer with WebRTC.
 - [trystero](https://github.com/dmotz/trystero) - Build instant multiplayer webapps, no server required.
 
+## License
+
+MIT
+
 ## Maintainers
 
-[Nuzulul Zulkarnain](https://github.com/nuzulul)
+[Nuzulul Zulkarnain](https://github.com/nuzulul)
+

package/dist/esm/webpeerjs.d.ts

@@ -9,8 +9,9 @@ export class webpeerjs {
     };
     address: any[];
     peers: any[];
-    onJoin: (f: any) => any;
-    onLeave: (f: any) => any;
+    onConnect: (f: any) => any;
+    onDisconnect: (f: any) => any;
     joinRoom: (room: any) => any[];
+    dial(addr: any): void;
     #private;
 }