From 7df00746677a0802feca0853bb097f3f754daf85 Mon Sep 17 00:00:00 2001 From: David Dias Date: Fri, 7 Jul 2017 16:02:32 +0100 Subject: [PATCH] docs: add disclaimers for each example --- examples/README.md | 18 +++++++++--------- examples/discovery-mechanisms/README.md | 2 ++ examples/encrypted-communications/README.md | 2 ++ examples/libp2p-in-the-browser/README.md | 2 ++ examples/nat-traversal/README.md | 2 ++ examples/peer-routing/README.md | 2 ++ examples/protocol-and-stream-muxing/README.md | 2 ++ examples/pubsub/README.md | 2 ++ 8 files changed, 23 insertions(+), 9 deletions(-) create mode 100644 examples/discovery-mechanisms/README.md create mode 100644 examples/encrypted-communications/README.md create mode 100644 examples/libp2p-in-the-browser/README.md create mode 100644 examples/nat-traversal/README.md create mode 100644 examples/peer-routing/README.md create mode 100644 examples/protocol-and-stream-muxing/README.md create mode 100644 examples/pubsub/README.md diff --git a/examples/README.md b/examples/README.md index ed333573..121e62b6 100644 --- 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 new file mode 100644 index 00000000..38f33cef --- /dev/null +++ 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 new file mode 100644 index 00000000..38f33cef --- /dev/null +++ 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 new file mode 100644 index 00000000..38f33cef --- /dev/null +++ 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 new file mode 100644 index 00000000..38f33cef --- /dev/null +++ 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 new file mode 100644 index 00000000..38f33cef --- /dev/null +++ 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 new file mode 100644 index 00000000..38f33cef --- /dev/null +++ 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 new file mode 100644 index 00000000..38f33cef --- /dev/null +++ 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)