structure examples

libp2p · Jul 3, 2017 · 11e0449 · 11e0449
1 parent e3bf193
commit 11e0449
Show file tree

Hide file tree

Showing 14 changed files with 16 additions and 10 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -1,6 +1,13 @@
-### Examples list
+# `js-libp2p` Examples and Tutorials
 
-Here are some examples built with libp2p bundles.
+In this folder, you can find a variety of examples to help you get started in using js-libp2p, in Node.js and in the Browser. Every example as a specific purpose and some of each incorporate a full tutorial that you can follow through, helping you expand your knowledge about libp2p and p2p networks in general.
 
-- https://github.com/ipfs/js-libp2p-ipfs/tree/master/examples/echo
-- https://github.com/ipfs/js-libp2p-ipfs/tree/master/examples/chat
+Let us know if you find any issue or if you want to contribute and add a new tutorial, feel welcome to submit a PR, thank you!
+
+## Examples
+
+- [In Node.js](./nodejs)
+  - [echo](./nodejs/echo)
+  - [chat](./nodejs/chat)
+- [In the browser](./browser)
+  - [mapper](./browser/mapper)
diff --git a/...les-ipfs-browser-bundle/mapper/.gitignore → examples/browser/mapper/.gitignore b/...les-ipfs-browser-bundle/mapper/.gitignore → examples/browser/mapper/.gitignore
diff --git a/...s-ipfs-browser-bundle/mapper/package.json → examples/browser/mapper/package.json b/...s-ipfs-browser-bundle/mapper/package.json → examples/browser/mapper/package.json
diff --git a/...s-browser-bundle/mapper/public/index.html → examples/browser/mapper/public/index.html b/...s-browser-bundle/mapper/public/index.html → examples/browser/mapper/public/index.html
diff --git a/...-browser-bundle/mapper/src/create-node.js → examples/browser/mapper/src/create-node.js b/...-browser-bundle/mapper/src/create-node.js → examples/browser/mapper/src/create-node.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const PeerInfo = require('peer-info')
-const Node = require('../../../src')
+const Node = require('../../../../test/browser-bundle/browser-bundle.js')
 
 function createNode (callback) {
   PeerInfo.create((err, peerInfo) => {

diff --git a/...s-ipfs-browser-bundle/mapper/src/index.js → examples/browser/mapper/src/index.js b/...s-ipfs-browser-bundle/mapper/src/index.js → examples/browser/mapper/src/index.js
diff --git a/...xamples-ipfs-nodejs-bundle/chat/dialer.js → examples/nodejs/chat/dialer.js b/...xamples-ipfs-nodejs-bundle/chat/dialer.js → examples/nodejs/chat/dialer.js
@@ -3,10 +3,9 @@
 
 const PeerId = require('peer-id')
 const PeerInfo = require('peer-info')
-const Node = require('../../src')
+const Node = require('../../../../test/nodejs-bundle/nodejs-bundle.js')
 const multiaddr = require('multiaddr')
 const pull = require('pull-stream')
-// const toPull = require('stream-to-pull-stream')
 const async = require('async')
 const Pushable = require('pull-pushable')
 const p = Pushable()

diff --git a/...mples-ipfs-nodejs-bundle/chat/listener.js → examples/nodejs/chat/listener.js b/...mples-ipfs-nodejs-bundle/chat/listener.js → examples/nodejs/chat/listener.js
@@ -3,7 +3,7 @@
 
 const PeerId = require('peer-id')
 const PeerInfo = require('peer-info')
-const Node = require('../../src')
+const Node = require('../../../../test/nodejs-bundle/nodejs-bundle.js')
 const multiaddr = require('multiaddr')
 const pull = require('pull-stream')
 const Pushable = require('pull-pushable')

diff --git a/...fs-nodejs-bundle/chat/peer-id-dialer.json → examples/nodejs/chat/peer-id-dialer.json b/...fs-nodejs-bundle/chat/peer-id-dialer.json → examples/nodejs/chat/peer-id-dialer.json
diff --git a/...-nodejs-bundle/chat/peer-id-listener.json → examples/nodejs/chat/peer-id-listener.json b/...-nodejs-bundle/chat/peer-id-listener.json → examples/nodejs/chat/peer-id-listener.json
diff --git a/...xamples-ipfs-nodejs-bundle/echo/dialer.js → examples/nodejs/echo/dialer.js b/...xamples-ipfs-nodejs-bundle/echo/dialer.js → examples/nodejs/echo/dialer.js
@@ -7,7 +7,7 @@
 
 const PeerId = require('peer-id')
 const PeerInfo = require('peer-info')
-const Node = require('../../src')
+const Node = require('../../../../test/nodejs-bundle/nodejs-bundle.js')
 const multiaddr = require('multiaddr')
 const pull = require('pull-stream')
 const async = require('async')

diff --git a/...xamples-ipfs-nodejs-bundle/echo/id-d.json → examples/nodejs/echo/id-d.json b/...xamples-ipfs-nodejs-bundle/echo/id-d.json → examples/nodejs/echo/id-d.json
diff --git a/...xamples-ipfs-nodejs-bundle/echo/id-l.json → examples/nodejs/echo/id-l.json b/...xamples-ipfs-nodejs-bundle/echo/id-l.json → examples/nodejs/echo/id-l.json
diff --git a/...mples-ipfs-nodejs-bundle/echo/listener.js → examples/nodejs/echo/listener.js b/...mples-ipfs-nodejs-bundle/echo/listener.js → examples/nodejs/echo/listener.js
@@ -7,7 +7,7 @@
 
 const PeerId = require('peer-id')
 const PeerInfo = require('peer-info')
-const Node = require('../../src')
+const Node = require('../../../../test/nodejs-bundle/nodejs-bundle.js')
 const multiaddr = require('multiaddr')
 const pull = require('pull-stream')
 const series = require('async/series')