From c462d1a49bec47325cc3cd500aa4a792d4b08ea9 Mon Sep 17 00:00:00 2001 From: Volker Mische Date: Tue, 14 Aug 2018 12:55:47 +0200 Subject: [PATCH] docs: make example from README copy & pastable The example in the README can now be used with simply copy & pasting, no errors will be thrown. Fixes #234. --- README.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 25e31e965d..48f4a479df 100644 --- a/README.md +++ b/README.md @@ -118,11 +118,8 @@ const defaultsDeep = require('@nodeutils/defaults-deep') const Protector = require('libp2p-pnet') class Node extends libp2p { - constructor (_peerInfo, _peerBook, _options) { + constructor (_options) { const defaults = { - peerInfo: _peerInfo, // The Identity of your Peer - peerBook: _peerBook, // Where peers get tracked, if undefined libp2p will create one instance - // The libp2p modules for this libp2p bundle modules: { transport: [ @@ -136,12 +133,11 @@ class Node extends libp2p { connEncryption: [ SECIO ], - connProtector: new Protector(/*protector specific opts*/), + // Encryption for private networks. Needs additional private key to work + // connProtector: new Protector(/*protector specific opts*/), peerDiscovery: [ MulticastDNS ], - peerRouting: {}, // Currently both peerRouting and contentRouting are patched through the DHT, - contentRouting: {}, // this will change once we factor that into two modules, for now do the following line: dht: DHT // DHT enables PeerRouting, ContentRouting and DHT itself components }, @@ -158,8 +154,6 @@ class Node extends libp2p { } // .. other discovery module options. }, - peerRouting: {}, - contentRouting: {}, relay: { // Circuit Relay options enabled: false, hop: {