docs: add disclaimers for each example

libp2p · Jul 7, 2017 · 7df0074 · 7df0074
1 parent b14a2ff
commit 7df0074
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 9 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -6,20 +6,20 @@ Let us know if you find any issue or if you want to contribute and add a new tut
 
 ## Understanding how libp2p works
 
-- [Transports]()
-- [Stream and Protocol Muxing]()
-- [Encrypted Communications]()
-- [Discovery Mechanisms]()
-- [Peer Routing]()
-- [Content Routing]()
-- [PubSub]()
-- [NAT Traversal]()
+- [Transports](./transports)
+- [Stream and Protocol Muxing](./protocol-and-stream-muxing)
+- [Encrypted Communications](./encrypted-communications)
+- [Discovery Mechanisms](./discovery-mechanisms)
+- [Peer Routing](./peer-routing)
+- [Content Routing](./content-routing)
+- [PubSub](./pubsub)
+- [NAT Traversal](./nat-traversal)
 - Circuit Relay (future)
 - Naming (future)
 
 ## Other examples
 
-- [Running libp2p in the Browser]()
+- [Running libp2p in the Browser](./libp2p-in-the-browser)
 - Running libp2p in the Electron (future)
 - [The standard echo net example with libp2p](./echo)
 - [A simple chat app with](./chat)

diff --git a/examples/discovery-mechanisms/README.md b/examples/discovery-mechanisms/README.md
@@ -0,0 +1,2 @@
+# WIP - This example is still in the works
+![](http://1.bp.blogspot.com/-tNvSnCW0KlQ/U-KOKGVoJkI/AAAAAAAAA3Q/aiSLMeSJFtw/s1600/WIP-sign.jpg)
diff --git a/examples/encrypted-communications/README.md b/examples/encrypted-communications/README.md
@@ -0,0 +1,2 @@
+# WIP - This example is still in the works
+![](http://1.bp.blogspot.com/-tNvSnCW0KlQ/U-KOKGVoJkI/AAAAAAAAA3Q/aiSLMeSJFtw/s1600/WIP-sign.jpg)
diff --git a/examples/libp2p-in-the-browser/README.md b/examples/libp2p-in-the-browser/README.md
@@ -0,0 +1,2 @@
+# WIP - This example is still in the works
+![](http://1.bp.blogspot.com/-tNvSnCW0KlQ/U-KOKGVoJkI/AAAAAAAAA3Q/aiSLMeSJFtw/s1600/WIP-sign.jpg)
diff --git a/examples/nat-traversal/README.md b/examples/nat-traversal/README.md
@@ -0,0 +1,2 @@
+# WIP - This example is still in the works
+![](http://1.bp.blogspot.com/-tNvSnCW0KlQ/U-KOKGVoJkI/AAAAAAAAA3Q/aiSLMeSJFtw/s1600/WIP-sign.jpg)
diff --git a/examples/peer-routing/README.md b/examples/peer-routing/README.md
@@ -0,0 +1,2 @@
+# WIP - This example is still in the works
+![](http://1.bp.blogspot.com/-tNvSnCW0KlQ/U-KOKGVoJkI/AAAAAAAAA3Q/aiSLMeSJFtw/s1600/WIP-sign.jpg)
diff --git a/examples/protocol-and-stream-muxing/README.md b/examples/protocol-and-stream-muxing/README.md
@@ -0,0 +1,2 @@
+# WIP - This example is still in the works
+![](http://1.bp.blogspot.com/-tNvSnCW0KlQ/U-KOKGVoJkI/AAAAAAAAA3Q/aiSLMeSJFtw/s1600/WIP-sign.jpg)
diff --git a/examples/pubsub/README.md b/examples/pubsub/README.md
@@ -0,0 +1,2 @@
+# WIP - This example is still in the works
+![](http://1.bp.blogspot.com/-tNvSnCW0KlQ/U-KOKGVoJkI/AAAAAAAAA3Q/aiSLMeSJFtw/s1600/WIP-sign.jpg)