diff --git a/README.md b/README.md index d5fff31..db71478 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ -# abstract-stream-muxer -A test suite and interface you can use to implement a stream muxer. +abstract-stream-muxer +===================== + +[![](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) + +> A test suite and interface you can use to implement a stream muxer. + +# Modules that implement the interface + +- + +Send a PR to add a new one if you happen to find or write one. + +# Badge + +![](/img/badge.png) + +# How to use + + +# API + +A valid (read: that follows this abstraction) stream muxer, must implement the following API. + +### `Node.js` muxer.attach(transport, function (err, conn)) || `Go` conn, err := muxer.attach(transport) + + +### `Node.js` conn.dialStream(function (err, stream)) || `Go` stream, err := conn.dialStream() + + +### `Node.js` conn.on('stream', function (stream)) || `Go` stream := conn.listen() diff --git a/img/badge.png b/img/badge.png new file mode 100644 index 0000000..738bcf4 Binary files /dev/null and b/img/badge.png differ diff --git a/img/badge.sketch b/img/badge.sketch new file mode 100644 index 0000000..990ad1c Binary files /dev/null and b/img/badge.sketch differ diff --git a/img/badge.svg b/img/badge.svg new file mode 100644 index 0000000..d721596 --- /dev/null +++ b/img/badge.svg @@ -0,0 +1,18 @@ + + + + badge + Created with Sketch. + + + + + + Stream Muxer + + + Compatibl + e + + + \ No newline at end of file