js-libp2p-websockets/README.md

# js-libp2p-websockets

[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
[![Coverage Status](https://coveralls.io/repos/github/libp2p/js-libp2p-websockets/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-libp2p-websockets?branch=master)
[![Travis CI](https://travis-ci.org/libp2p/js-libp2p-websockets.svg?branch=master)](https://travis-ci.org/libp2p/js-libp2p-websockets)
[![Circle CI](https://circleci.com/gh/libp2p/js-libp2p-websockets.svg?style=svg)](https://circleci.com/gh/libp2p/js-libp2p-websockets)
[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-websockets.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-websockets)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
![](https://img.shields.io/badge/Node.js-%3E%3D4.0.0-orange.svg?style=flat-square)

[![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)
[![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)](https://github.com/libp2p/interface-connection)

> JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport interface

## Description

`libp2p-websockets` is the WebSockets implementation compatible with libp2p.

## Usage

## Install

### npm

```sh
> npm i libp2p-websockets
```

### Example

```
TODO
```

## API

### Transport

[![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)

### Connection

[![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)](https://github.com/libp2p/interface-connection)
chore: minor cleanup and updates 2016-08-11 11:59:11 +02:00			`# js-libp2p-websockets`
badgers 2016-02-26 11:01:52 +00:00
			`[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)`
chore: minor cleanup and updates 2016-08-11 11:59:11 +02:00			`[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)`
dial and listen done 2016-03-14 20:25:00 +00:00			`[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)`
chore: minor cleanup and updates 2016-08-11 11:59:11 +02:00			`[![Coverage Status](https://coveralls.io/repos/github/libp2p/js-libp2p-websockets/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-libp2p-websockets?branch=master)`
			`[![Travis CI](https://travis-ci.org/libp2p/js-libp2p-websockets.svg?branch=master)](https://travis-ci.org/libp2p/js-libp2p-websockets)`
			`[![Circle CI](https://circleci.com/gh/libp2p/js-libp2p-websockets.svg?style=svg)](https://circleci.com/gh/libp2p/js-libp2p-websockets)`
docs: no sauce badges 2017-10-20 12:27:51 +01:00			`[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-websockets.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-websockets)`
			`[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)`
feat: upgrade to aegir@9 (#33) 2016-11-03 09:53:50 +01:00			`![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)`
			`![](https://img.shields.io/badge/Node.js-%3E%3D4.0.0-orange.svg?style=flat-square)`

docs: update and polish README 2018-02-20 10:32:38 +00:00			`[![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)`
			`[![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)](https://github.com/libp2p/interface-connection)`
feat: upgrade to aegir@9 (#33) 2016-11-03 09:53:50 +01:00
follow new transport and connection spec 2016-06-19 06:35:31 +01:00			`> JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport interface`
feat(readme): complete the readme, adding reference about pull-streams 2016-09-05 19:07:00 -04:00
			`## Description`

			`libp2p-websockets` is the WebSockets implementation compatible with libp2p.

docs: update and polish README 2018-02-20 10:32:38 +00:00			`## Usage`
feat(readme): complete the readme, adding reference about pull-streams 2016-09-05 19:07:00 -04:00
docs: update and polish README 2018-02-20 10:32:38 +00:00			`## Install`
feat(readme): complete the readme, adding reference about pull-streams 2016-09-05 19:07:00 -04:00
			`### npm`

			```sh
			`> npm i libp2p-websockets`
			```

docs: update and polish README 2018-02-20 10:32:38 +00:00			`### Example`
feat(readme): complete the readme, adding reference about pull-streams 2016-09-05 19:07:00 -04:00
docs: update and polish README 2018-02-20 10:32:38 +00:00			```
			`TODO`
feat(readme): complete the readme, adding reference about pull-streams 2016-09-05 19:07:00 -04:00			```

docs: update and polish README 2018-02-20 10:32:38 +00:00			`## API`
feat(readme): update pull-streams section 2016-09-06 09:37:27 -04:00
docs: update and polish README 2018-02-20 10:32:38 +00:00			`### Transport`
feat(readme): update pull-streams section 2016-09-06 09:37:27 -04:00
docs: update and polish README 2018-02-20 10:32:38 +00:00			`[![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)`
feat(readme): complete the readme, adding reference about pull-streams 2016-09-05 19:07:00 -04:00
docs: update and polish README 2018-02-20 10:32:38 +00:00			`### Connection`
feat(readme): complete the readme, adding reference about pull-streams 2016-09-05 19:07:00 -04:00
docs: update and polish README 2018-02-20 10:32:38 +00:00			`[![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)](https://github.com/libp2p/interface-connection)`