webpeerjs 0.1.4 → 0.1.6

package/README.md

@@ -1,20 +1,29 @@
 # WebPEER.js
 > Decentralized P2P JS library for communication between applications in browser.
 
-Build completely peer-to-peer web applications, no trackers or relay servers required. [WebPEER.js](https://github.com/nuzulul/webpeerjs) enables browser to browser connectivity without a central server. Connecting projects safely, privately, and reliably.
+[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.
 
 [Basic Connection Demo](https://nuzulul.github.io/webpeerjs/demo/)
 
+## Security
+
+WebPEER.js uses [`libp2p gossipsub`](https://docs.libp2p.io/concepts/security/security-considerations/#publish--subscribe) to enables communication between peers. 
+> By default, the gossipsub implementation will sign all messages with the author’s private key, and require a valid signature before accepting or propagating a message further. This prevents messages from being altered in flight, and allows recipients to authenticate the sender.
+
+> However, as a cooperative protocol, it may be possible for peers to interfere with the message routing algorithm in a way that disrupts the flow of messages through the network.
+
 ## Features
 
 * ✅ Decentralized P2P
-* ✅ Unlimited Peers
+* ✅ Scalable Peers
 * ✅ Works in Browsers
-* ✅ Broadcast Message
-
-## Security
+* ✅ Broadcast Messages
+* ✅ Censorship Resistant
 
-WebPEER.js uses [`libp2p gossipsub`](https://docs.libp2p.io/concepts/security/security-considerations/#publish--subscribe) to enables communication between applications. 
+## 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) | ![Safari](https://raw.github.com/alrra/browser-logos/master/src/safari/safari_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) |
+--- | --- | --- | --- | --- | --- |
+Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
 
 ## Quickstart