fluencelabs/js-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p synced 2025-03-16 07:30:51 +00:00
Code Issues Projects Releases Wiki Activity

docs: update API for node creation (#236)

Browse Source 
The API changed recently, update the README to reflect that.
This commit is contained in:
Volker Mische 2018-08-14 14:23:55 +02:00 committed by Jacob Heun
parent 65e7223ce0
commit fdd714ee60
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -182,13 +182,13 @@ class Node extends libp2p {
### API
#### Create a Node - `new libp2p.Node([peerInfo, peerBook, options])`
#### Create a Node - `new libp2p.Node(options)`
> Creates an instance of the libp2p.Node.
- `peerInfo`: instance of [PeerInfo][] that contains the [PeerId][], Keys and [multiaddrs][multiaddr] of the libp2p Node. Optional.
- `peerBook`: instance of [PeerBook][] that contains the [PeerInfo][] of known peers. Optional.
- `options`: Object containing custom options for the bundle.
Required keys in the `options` object:
- `peerInfo`: instance of [PeerInfo][] that contains the [PeerId][], Keys and [multiaddrs][multiaddr] of the libp2p Node.
#### `libp2p.start(callback)`