feat(readme): complete the readme and add note about pull-streams

README.md

@@ -3,12 +3,60 @@ js-libp2p-webrtc-star
 
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
 [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
-[![Build Status](https://travis-ci.org/diasdavid/js-libp2p-webrtc-star.svg?style=flat-square)](https://travis-ci.org/diasdavid/js-libp2p-webrtc-star)
+[![Build Status](https://travis-ci.org/libp2p/js-libp2p-webrtc-star.svg?style=flat-square)](https://travis-ci.org/libp2p/js-libp2p-webrtc-star)
 ![](https://img.shields.io/badge/coverage-%3F-yellow.svg?style=flat-square)
-[![Dependency Status](https://david-dm.org/diasdavid/js-libp2p-webrtc-star.svg?style=flat-square)](https://david-dm.org/diasdavid/js-libp2p-webrtc-star)
+[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-webrtc-star.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-webrtc-star)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https:/feross/standard)
 
-![](https://raw.githubusercontent.com/diasdavid/interface-connection/master/img/badge.png)
-![](https://raw.githubusercontent.com/diasdavid/interface-transport/master/img/badge.png)
+![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)
+![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)
 
 > libp2p WebRTC transport that includes a discovery mechanism provided by the signalling-star
+
+## Description
+
+`libp2p-webrtc-star` is one of the WebRTC transports available for libp2p. `libp2p-webrtc-star incorporates both a transport and a discovery service that is facilitated by the signalling server, also part of this module.
+
+**Note:** This module uses [pull-streams](https://pull-stream.github.io) for all stream based interfaces.
+
+## Example
+
+```
+TODO
+```
+
+## Installation
+
+### npm
+
+```sh
+> npm i libp2p-webrtc-star
+```
+
+## This module uses `pull-streams`
+
+We expose a streaming interface based on `pull-streams`, rather then on the Node.js core streams implementation (aka Node.js streams). `pull-streams` offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about what took us to make this migration, see the discussion at this [issue](https:/ipfs/js-ipfs/issues/362).
+
+You can learn more about pull-streams at:
+
+- [The history of Node.js streams, nodebp April 2014](https://www.youtube.com/watch?v=g5ewQEuXjsQ)
+- [The history of streams, 2016](http://dominictarr.com/post/145135293917/history-of-streams)
+- [pull-streams, the simple streaming primitive](http://dominictarr.com/post/149248845122/pull-streams-pull-streams-are-a-very-simple)
+- [pull-streams documentation](https://pull-stream.github.io/)
+
+### Converting `pull-streams` to Node.js Streams
+
+If you are a Node.js streams user, you can convert a pull-stream to Node.js Stream using the module `pull-stream-to-stream`, giving you an instance of a Node.js stream that is linked to the pull-stream. Example:
+
+```
+const pullToStream = require('pull-stream-to-stream')
+
+const nodeStreamInstance = pullToStream(pullStreamInstance)
+// nodeStreamInstance is an instance of a Node.js Stream
+```
+
+To learn more about his utility, visit https://pull-stream.github.io/#pull-stream-to-stream
+
+## API
+
+[![](https://raw.githubusercontent.com/diasdavid/interface-transport/master/img/badge.png)](https:/diasdavid/interface-transport)

package.json

@@ -47,8 +47,7 @@
  },
  "dependencies": {
  "debug": "^2.2.0",
- "hapi": "^15.0.2",
- "interface-connection": "^0.1.8",
+ "interface-connection": "^0.2.1",
  "mafmt": "^2.1.0",
  "minimist": "^1.2.0",
  "peer-id": "^0.7.0",