fluencelabs/js-libp2p-tcp
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-tcp synced 2025-04-25 15:22:34 +00:00
Code Issues Projects Releases Wiki Activity

Adds README stub.

Browse Source
This commit is contained in:
Stephen Whitmore 2016-04-21 16:18:39 -07:00
parent d582fb5f61
commit 3c6bce9d28
1 changed files with 56 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -11,6 +11,60 @@ js-libp2p-tcp
![](https://raw.githubusercontent.com/diasdavid/abstract-connection/master/img/badge.png)
![](https://raw.githubusercontent.com/diasdavid/abstract-transport/master/img/badge.png)
> Node.js implementation of the TCP module that libp2p uses, which implements the [interface-connection](https://github.com/diasdavid/interface-connection) interface for dial/listen.
> Node.js implementation of the TCP module that libp2p uses, which implements
> the [interface-connection](https://github.com/diasdavid/interface-connection)
> interface for dial/listen.
note: libp2p-tcp in Node.js is a very thin shim that adds the support to dial to a `multiaddr`. This small shim will enable libp2p to use other different transports.
## Description
`libp2p-tcp` in Node.js is a very thin shim that adds the support to dial to a
`multiaddr`. This small shim will enable libp2p to use other different
transports.
## Example
```js
```
outputs
```
```
## Installation
### npm
```sh
> npm i libp2p-tcp
```
## API
```js
const Tcp = require('libp2p-tcp')
```
### var tcp = new Tcp()
...
### tcp.dial(multiaddr, options)
...
### tcp.createListener(multiaddrs, handler, callback)
...
### tcp.close(callback)
...
### tcp.filter(multiaddrs)
...
## License
MIT