From fdd714ee607b32945e83bd40e74ccd63a4ad3bc3 Mon Sep 17 00:00:00 2001 From: Volker Mische Date: Tue, 14 Aug 2018 14:23:55 +0200 Subject: [PATCH] docs: update API for node creation (#236) The API changed recently, update the README to reflect that. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 48f4a479..52e97d58 100644 --- a/README.md +++ b/README.md @@ -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)`