libp2p · Stebalien · Aug 21, 2017 · Aug 19, 2017 · Aug 19, 2017 · Aug 19, 2017
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
diff --git a/Makefile b/Makefile
@@ -2,7 +2,7 @@ gx:
 	go get github.com/whyrusleeping/gx
 	go get github.com/whyrusleeping/gx-go
 
-deps-examples: deps
+deps-protocol-muxing: deps
 	go get -u github.com/multiformats/go-multicodec
 	go get -u github.com/jbenet/go-msgio
 
@@ -12,4 +12,3 @@ deps: gx
 
 publish:
 	gx-go rewrite --undo
-
diff --git a/README.md b/README.md
@@ -1,47 +1,80 @@
-[libp2p](https://github.com/libp2p/specs) implementation in Go.
-===================
-
-[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
-[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
-[![GoDoc](https://godoc.org/github.com/ipfs/go-libp2p?status.svg)](https://godoc.org/github.com/libp2p/go-libp2p)
-[![Build Status](https://travis-ci.org/ipfs/go-libp2p.svg?branch=master)](https://travis-ci.org/libp2p/go-libp2p)
-
-![](https://raw.githubusercontent.com/diasdavid/specs/libp2p-spec/protocol/network/figs/logo.png)
-
-> libp2p implementation in Go
-
-# Description
+<h1 align="center">
+  <a href="libp2p.io"><img width="250" src="https://github.com/libp2p/libp2p/blob/master/logo/alternates/libp2p-logo-alt-2.png?raw=true" alt="libp2p hex logo" /></a>
+</h1>
+
+<h3 align="center">The Go implementation of the libp2p Networking Stack.</h3>
+
+<p align="center">
+  <a href="http://ipn.io"><img src="https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square" /></a>
+  <a href="http://libp2p.io/"><img src="https://img.shields.io/badge/project-libp2p-blue.svg?style=flat-square" /></a>
+  <a href="http://webchat.freenode.net/?channels=%23ipfs"><img src="https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square" /></a>
+  <a href="https://waffle.io/libp2p/libp2p"><img src="https://img.shields.io/badge/pm-waffle-blue.svg?style=flat-square" /></a>
+</p>
+
+<p align="center">
+  <a href="https://travis-ci.org/libp2p/go-libp2p"><img src="https://travis-ci.org/libp2p/go-libp2p.svg?branch=master" /></a>
+  <!--<a href="https://circleci.com/gh/libp2p/go-libp2p"><img src="https://circleci.com/gh/libp2p/go-libp2p.svg?style=svg" /></a>-->
+  <!--<a href="https://coveralls.io/github/libp2p/go-libp2p?branch=master"><img src="https://coveralls.io/repos/github/libp2p/go-libp2p/badge.svg?branch=master"></a>-->
+  <br>
+  <a href="https://github.com/RichardLitt/standard-readme"><img src="https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square" /></a>
+  <a href="https://godoc.org/github.com/libp2p/go-libp2p"><img src="https://godoc.org/github.com/ipfs/go-libp2p?status.svg" /></a>
+  <a href=""><img src="https://img.shields.io/badge/golang-%3E%3D1.8.0-orange.svg?style=flat-square" /></a>
+  <br>
+</p>
+
+# Project status
+
+[![Throughput Graph](https://graphs.waffle.io/libp2p/go-libp2p/throughput.svg)](https://waffle.io/libp2p/go-libp2p/metrics/throughput)
+
+# Table of Contents
+
+- [Background](#background)
+- [Bundles](#bundles)
+- [Usage](#usage)
+  - [Install](#install)
+  - [API](#api)
+  - [Examples](#examples)
+- [Development](#development)
+  - [Tests](#tests)
+  - [Packages](#packages)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Background
 
 [libp2p](https://github.com/libp2p/specs) is a networking stack and library modularized out of [The IPFS Project](https://github.com/ipfs/ipfs), 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. But in the meantime, check out
 >
-> - [**The IPFS Network Spec**](https://github.com/libp2p/specs), which grew into libp2p
+> - [**The libp2p Specification**](https://github.com/libp2p/specs)
 > - [**go-libp2p implementation**](https://github.com/libp2p/go-libp2p)
 > - [**js-libp2p implementation**](https://github.com/libp2p/js-libp2p)
 
-# Contribute
 
-libp2p implementation in Go is a work in progress. As such, there's a few things you can do right now to help out:
- - Go through the modules below and **check out existing issues**. This would be especially useful for modules in active development. Some knowledge of IPFS/libp2p may be required, as well as the infrasture behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
- - **Perform code reviews**.
- - **Add tests**. There can never be enough tests.
+## Bundles
+
+There is currently only one bundle of `go-libp2p`, this package. This bundle is used by [`go-ipfs`](https://github.com/ipfs/go-ipfs).
 
-# Usage
+## Usage
 
-`go-libp2p` repo will be a place holder for the list of Go modules that compose Go libp2p, as well as its entry point.
+`go-libp2p` repo is a place holder for the list of Go modules that compose Go libp2p, as well as its entry point.
 
-## Install
+### Install
 
 ```bash
-$ go get -d github.com/libp2p/go-libp2p
-$ cd $GOPATH/src/github.com/libp2p/go-libp2p
-$ make
+> go get -d github.com/libp2p/go-libp2p
+> cd $GOPATH/src/github.com/libp2p/go-libp2p
+> make
+> make deps
 ```
 
-# Examples
+### API
+
+[![GoDoc](https://godoc.org/github.com/ipfs/go-libp2p?status.svg)](https://godoc.org/github.com/libp2p/go-libp2p)
+
+### Examples
 
 Examples can be found on the [examples folder](examples).
 
@@ -50,18 +83,72 @@ Examples can be found on the [examples folder](examples).
 ```bash
 $ cd $GOPATH/src/github.com/libp2p/go-libp2p
 $ make deps
-$ go test ./p2p/<path of module you want to run tests for>
+$ gx test ./p2p/<path of module you want to run tests for>
 ```
 
+## Development
+
+### Dependencies
+
+While developing, you need to use [gx to install and link your dependencies](https://github.com/whyrusleeping/gx#dependencies), to do that, run:
+
+```sh
+> make deps
+```
 
-## Links
-- [**Specs**](https://github.com/libp2p/specs)
-- [**Website**](https://github.com/libp2p/website)
+Before commiting and pushing to Github, make sure to rewind the gx'ify of dependencies. You can do that with:
+
+```sh
+> make publish
+```
+
+### Tests
+
+Running of individual tests is done through `gx test <path to test>`
+
+### Packages
+
+> **WIP**
+
+List of packages currently in existence for libp2p:
+
+| Package            | Version | CI                  |
+|--------------------|---------|---------------------|
+| **Transports**                                     |
+| **Connection Upgrades**                            |
+| **Stream Muxers**                                  |
+| **Discovery**                                      |
+| **Crypto Channels**                                |
+| **Peer Routing**                                   |
+| **Content Routing**                                |
+| **Miscellaneous**                                  |
+| **Data Types**                                     |
+
+# Contribute
+
+go-libp2p is part of [The IPFS Project](https://github.com/ipfs/ipfs), and is MIT licensed open source software. We welcome contributions big and small! Take a look at the [community contributing notes](https://github.com/ipfs/community/blob/master/contributing.md). Please make sure to check the [issues](https://github.com/ipfs/go-libp2p/issues). Search the closed ones before reporting things, and help us with the open ones.
+
+Guidelines:
+
+- read the [libp2p spec](https://github.com/libp2p/specs)
+- please make branches + pull-request, even if working on the main repository
+- ask questions or talk about things in [Issues](https://github.com/libp2p/go-libp2p/issues) or #ipfs on freenode.
+- ensure you are able to contribute (no legal issues please-- we use the DCO)
+- run `go fmt` before pushing any code
+- run `golint` and `go vet` too -- some things (like protobuf files) are expected to fail.
+- get in touch with @jbenet and @diasdavid about how best to contribute
+- have fun!
+
+There's a few things you can do right now to help out:
+ - Go through the modules below and **check out existing issues**. This would be especially useful for modules in active development. Some knowledge of IPFS/libp2p may be required, as well as the infrasture behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
+ - **Perform code reviews**.
+ - **Add tests**. There can never be enough tests.
 
+## Modularizing go-libp2p
 
-## Extracting packages from go-libp2p
+We have currently a work in progress of modularizing go-libp2p from a repo monolith to several packages in different repos that can be reused for other projects of swapped for custom libp2p builds.
 
-We want to maintain history, so we'll use git-subtree for extracting packages.
+We want to maintain history, so we'll use git-subtree for extracting packages. Find instructions below:
 
 ```sh
 # 1) create the extracted tree (has the directory specified as -P as its root)

diff --git a/TODO b/TODO
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,12 @@
+# `go-libp2p` examples and tutorials
+
+In this folder, you can find a variety of examples to help you get started in using go-libp2p. 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.
+
+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 and Tutorials
+
+- [The libp2p 'host'](./libp2p-host)
+- [Building an http proxy with libp2p](./http-proxy)
+- [Protocol Multiplexing with multicodecs](./protocol-multiplexing-with-multicodecs)
+- [An echo host](./echo)
diff --git a/examples/echo/README.md b/examples/echo/README.md
@@ -1,17 +1,12 @@
 # Echo client/server with libp2p
 
-This is an example that quickly shows how to use the `go-libp2p` stack,
-including Host/Basichost, Network/Swarm, Streams, Peerstores and
-Multiaddresses.
+This is an example that quickly shows how to use the `go-libp2p` stack, including Host/Basichost, Network/Swarm, Streams, Peerstores and Multiaddresses.
 
 This example can be started in either listen mode, or dial mode.
 
-In listen mode, it will sit and wait for incoming connections on the
-`/echo/1.0.0` protocol. Whenever it receives a stream, it will write the
-message `"Hello, world!"` over the stream and close it.
+In listen mode, it will sit and wait for incoming connections on the `/echo/1.0.0` protocol. Whenever it receives a stream, it will write the message `"Hello, world!"` over the stream and close it.
 
-In dial mode, the node will start up, connect to the given address, open a
-stream to the target peer, and read a message on the protocol `/echo/1.0.0`.
+In dial mode, the node will start up, connect to the given address, open a stream to the target peer, and read a message on the protocol `/echo/1.0.0`.
 
 ## Build
 
@@ -31,61 +26,27 @@ From `go-libp2p` base folder:
 2017/03/15 14:11:32 listening for connections
 ```
 
-The listener libp2p host will print its `Multiaddress`, which indicates how it
-can be reached (ip4+tcp) and its randomly generated ID (`QmYo41Gyb...`)
+The listener libp2p host will print its `Multiaddress`, which indicates how it can be reached (ip4+tcp) and its randomly generated ID (`QmYo41Gyb...`)
 
 Now, launch another node that talks to the listener:
 
 ```
 > ./echo -l 10001 -d /ip4/127.0.0.1/tcp/10000/ipfs/QmYo41GybvrXk8y8Xnm1P7pfA4YEXCpfnLyzgRPnNbG35e
 ```
 
-The new node with send the message `"Hello, world!"` to the
-listener, which will in turn echo it over the stream and close it. The
-listener logs the message, and the sender logs the response.
+The new node with send the message `"Hello, world!"` to the listener, which will in turn echo it over the stream and close it. The listener logs the message, and the sender logs the response.
 
 ## Details
 
-The `makeBasicHost()` function creates a
-[go-libp2p-basichost](https://godoc.org/github.com/libp2p/go-libp2p/p2p/host/basic)
-object. `basichost` objects wrap
-[go-libp2 swarms](https://godoc.org/github.com/libp2p/go-libp2p-swarm#Swarm)
-and should be used preferentially. A
-[go-libp2p-swarm Network](https://godoc.org/github.com/libp2p/go-libp2p-swarm#Network)
-is a `swarm` which complies to the
-[go-libp2p-net Network interface](https://godoc.org/github.com/libp2p/go-libp2p-net#Network)
-and takes care of maintaining streams, connections, multiplexing different
-protocols on them, handling incoming connections etc.
+The `makeBasicHost()` function creates a [go-libp2p-basichost](https://godoc.org/github.com/libp2p/go-libp2p/p2p/host/basic) object. `basichost` objects wrap [go-libp2 swarms](https://godoc.org/github.com/libp2p/go-libp2p-swarm#Swarm) and should be used preferentially. A [go-libp2p-swarm Network](https://godoc.org/github.com/libp2p/go-libp2p-swarm#Network) is a `swarm` which complies to the [go-libp2p-net Network interface](https://godoc.org/github.com/libp2p/go-libp2p-net#Network) and takes care of maintaining streams, connections, multiplexing different protocols on them, handling incoming connections etc.
 
 In order to create the swarm (and a `basichost`), the example needs:
 
-  * An
-    [ipfs-procotol ID](https://godoc.org/github.com/libp2p/go-libp2p-peer#ID)
-    like `QmNtX1cvrm2K6mQmMEaMxAuB4rTexhd87vpYVot4sEZzxc`. The example
-    autogenerates a key pair on every run and uses an ID extracted from the
-    public key (the hash of the public key). When using `-secio`, it uses
-    the key pair to encrypt communications.
-  * A [Multiaddress](https://godoc.org/github.com/multiformats/go-multiaddr),
-    which indicates how to reach this peer. There can be several of them
-    (using different protocols or locations for example). Example:
-    `/ip4/127.0.0.1/tcp/1234`.
-  * A
-    [go-libp2p-peerstore](https://godoc.org/github.com/libp2p/go-libp2p-peerstore),
-    which is used as a address book which matches node IDs to the
-    multiaddresses through which they can be contacted. This peerstore gets
-    autopopulated when manually opening a connection (with
-    [`Connect()`](https://godoc.org/github.com/libp2p/go-libp2p/p2p/host/basic#BasicHost.Connect). Alternatively,
-    we can manually
-    [`AddAddr()`](https://godoc.org/github.com/libp2p/go-libp2p-peerstore#AddrManager.AddAddr)
-    as in the example.
-
-A `basichost` can now open streams (bi-directional channel between to peers)
-using
-[NewStream](https://godoc.org/github.com/libp2p/go-libp2p/p2p/host/basic#BasicHost.NewStream)
-and use them to send and receive data tagged with a `Protocol.ID` (a
-string). The host can also listen for incoming connections for a given
-`Protocol` with
-[`SetStreamHandle()`](https://godoc.org/github.com/libp2p/go-libp2p/p2p/host/basic#BasicHost.SetStreamHandler).
-
-The example makes use of all of this to enable communication between a
-listener and a sender using protocol `/echo/1.0.0` (which could be any other thing).
+- An [ipfs-procotol ID](https://godoc.org/github.com/libp2p/go-libp2p-peer#ID) like `QmNtX1cvrm2K6mQmMEaMxAuB4rTexhd87vpYVot4sEZzxc`. The example autogenerates a key pair on every run and uses an ID extracted from the public key (the hash of the public key). When using `-secio`, it uses the key pair to encrypt communications.
+- A [Multiaddress](https://godoc.org/github.com/multiformats/go-multiaddr), which indicates how to reach this peer. There can be several of them (using different protocols or locations for example). Example: `/ip4/127.0.0.1/tcp/1234`.
+- A [go-libp2p-peerstore](https://godoc.org/github.com/libp2p/go-libp2p-peerstore), which is used as a address book which matches node IDs to the multiaddresses through which they can be contacted. This peerstore gets autopopulated when manually opening a connection (with [`Connect()`](https://godoc.org/github.com/libp2p/go-libp2p/p2p/host/basic#BasicHost.Connect). Alternatively, we can manually [`AddAddr()`](https://godoc.org/github.com/libp2p/go-libp2p-peerstore#AddrManager.AddAddr) as in the example.
+
+A `basichost` can now open streams (bi-directional channel between to peers) using [NewStream](https://godoc.org/github.com/libp2p/go-libp2p/p2p/host/basic#BasicHost.NewStream) and use them to send and receive data tagged with a `Protocol.ID` (a string). The host can also listen for incoming connections for a given
+`Protocol` with [`SetStreamHandle()`](https://godoc.org/github.com/libp2p/go-libp2p/p2p/host/basic#BasicHost.SetStreamHandler).
+
+The example makes use of all of this to enable communication between a listener and a sender using protocol `/echo/1.0.0` (which could be any other thing).