From 5ef24695fc39ab215b13982fe623a8aec321cf7a Mon Sep 17 00:00:00 2001 From: Drew Stone Date: Thu, 5 Apr 2018 11:55:25 -0400 Subject: [PATCH] docs: fixing the broken example in README (#91) * Working example fix * Char fix * Corrected output, and add yarn to gitignore --- .gitignore | 3 +++ README.md | 25 +++++++++++++++---------- 2 files changed, 18 insertions(+), 10 deletions(-) diff --git a/.gitignore b/.gitignore index 1c73b37..f427b41 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,9 @@ docs test/repo-tests* **/bundle.js +# yarn +yarn.lock + # Logs logs *.log diff --git a/README.md b/README.md index 8ecd680..2804b16 100644 --- a/README.md +++ b/README.md @@ -39,12 +39,11 @@ const TCP = require('libp2p-tcp') const multiaddr = require('multiaddr') const pull = require('pull-stream') -const mh1 = multiaddr('/ip4/127.0.0.1/tcp/9090') -const mh2 = multiaddr('/ip6/::/tcp/9092') +const mh = multiaddr('/ip4/127.0.0.1/tcp/9090') const tcp = new TCP() -const listener = tcp.createListener(mh1, (socket) => { +const listener = tcp.createListener((socket) => { console.log('new connection opened') pull( pull.values(['hello']), @@ -52,15 +51,21 @@ const listener = tcp.createListener(mh1, (socket) => { ) }) -listener.listen(() => { +listener.listen(mh, () => { console.log('listening') pull( - tcp.dial(mh1), - pull.log, - pull.onEnd(() => { - tcp.close() - }) + tcp.dial(mh), + pull.collect((err, values) => { + if (!err) { + console.log(`Value: ${values.toString()}`) + } else { + console.log(`Error: ${err}`) + } + + // Close connection after reading + listener.close() + }), ) }) ``` @@ -70,7 +75,7 @@ Outputs: ```sh listening new connection opened -hello +Value: hello ``` ## API