From 7a8439239e9f7f9d0967f2af212706bf96cb70e4 Mon Sep 17 00:00:00 2001 From: haad Date: Tue, 15 Nov 2016 09:08:46 +0100 Subject: [PATCH] Update README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 78b210c..7b18077 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,8 @@ This is the Javascript implementation and it works both in **Node.js** and **Bro ## Usage +*Note that to run this example, you need to have an [IPFS daemon](https://dist.ipfs.io/go-ipfs/floodsub-2), started with --enable-pubsub-experiment, running at localhost:5001* + ``` npm install orbit-db ipfs-api@https://github.com/haadcode/js-ipfs-api.git ``` @@ -47,7 +49,7 @@ const db = orbitdb.eventlog("feed name") db.add("hello world") .then(() => { const latest = db.iterator({ limit: 5 }).collect() - console.log(latest.join("\n")) + console.log(JSON.stringify(latest, null, 2)) }) ``` @@ -86,7 +88,7 @@ npm run examples:browser -Check the code in [examples/browser/index.js](https://github.com/haadcode/orbit-db/blob/master/examples/browser/index.js). +Check the code in [examples/browser/browser.html](https://github.com/haadcode/orbit-db/blob/master/examples/browser/browser.html). ### Node.js example