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: make example from README copy & pastable (#235)

Browse Source 
The example in the README can now be used with simply copy & pasting,
no errors will be thrown.

Fixes #234.
This commit is contained in:
Volker Mische 2018-08-14 14:17:18 +02:00 committed by Jacob Heun
parent eddec7d2e4
commit 65e7223ce0
1 changed files with 3 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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: {