README stub

chromatic-universe · Jul 30, 2016 · 51288ce · 51288ce
1 parent a66d54a
commit 51288ce
Show file tree

Hide file tree

Showing 9 changed files with 41 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,43 @@
 # libp2p
+
 This document presents libp2p, a modularized and extensible network stack to overcome the networking challenges faced when doing peer-to-peer applications. libp2p is used by IPFS as its networking library.
+
+![](img/logo.png)
+
+# Description
+
+libp2p is a networking stack and library modularized out of The IPFS Project, and bundled separately for other tools to use.
+
+libp2p is the product of a long, and arduous quest of understanding -- a deep dive into the internet's network stack, and plentiful peer-to-peer protocols from the past. Building large scale peer-to-peer systems has been complex and difficult in the last 15 years, and libp2p is a way to fix that. It is a "network stack" -- a protocol suite -- that cleanly separates concerns, and enables sophisticated applications to only use the protocols they absolutely need, without giving up interoperability and upgradeability. libp2p grew out of IPFS, but it is built so that lots of people can use it, for lots of different projects.
+
+We will be writing a set of docs, posts, tutorials, and talks to explain what p2p is, why it is tremendously useful, and how it can help your existing and new projects.
+
+## Stub Explanation
+
+### libp2p is the networking layer of IPFS
+
+![](img/libp2p.001.jpg)
+
+### a collection of p2p protocols
+
+![](img/libp2p.002.jpg)
+
+### modules that satisfy interfaces (roles)
+
+![](img/libp2p.003.jpg)
+
+### The whole of IPFS ...
+
+![](img/libp2p.004.jpg)
+
+### ... is made up of libp2p modules
+
+![](img/libp2p.005.jpg)
+
+### libp2p has two impls so far: Go and JS
+
+![](img/libp2p.006.jpg)
+
+### libp2p cool demo: orbit.libp2p.io (p2p chat)
+
+![](img/libp2p.007.jpg)
diff --git a/img/libp2p.001.jpg b/img/libp2p.001.jpg
diff --git a/img/libp2p.002.jpg b/img/libp2p.002.jpg
diff --git a/img/libp2p.003.jpg b/img/libp2p.003.jpg
diff --git a/img/libp2p.004.jpg b/img/libp2p.004.jpg
diff --git a/img/libp2p.005.jpg b/img/libp2p.005.jpg
diff --git a/img/libp2p.006.jpg b/img/libp2p.006.jpg
diff --git a/img/libp2p.007.jpg b/img/libp2p.007.jpg
diff --git a/img/logo.png b/img/logo.png