From c7a14581a7f5b70524b529cc272135813f3ef29d Mon Sep 17 00:00:00 2001 From: David Dias Date: Tue, 17 Nov 2015 19:12:33 +0000 Subject: [PATCH 1/6] add more information to the readme --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c1e7704f..35db1798 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,6 @@ [![GoDoc](https://godoc.org/github.com/ipfs/go-libp2p?status.svg)](https://godoc.org/github.com/ipfs/go-libp2p) [![Build Status](https://travis-ci.org/ipfs/go-libp2p.svg?branch=master)](https://travis-ci.org/ipfs/go-libp2p) - > [libp2p](https://github.com/ipfs/specs/tree/master/libp2p) 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. @@ -14,7 +13,19 @@ > > - [**The IPFS Network Spec**](https://github.com/ipfs/specs/tree/master/protocol/network), which grew into libp2p > - [**go-libp2p implementation**](https://github.com/ipfs/go-libp2p) -> - [**node-libp2p implementation**](https://github.com/diasdavid/node-libp2p) +> - [**js-libp2p implementation**](https://github.com/diasdavid/js-libp2p) -## This README is WIP +# Usage +## Install + +```bash +$ go get github.com/ipfs/go-libp2p +``` + +# Run tests + +```bash +$ cd $GOPATH/src/github.com/ipfs/go-libp2p +$ GO15VENDOREXPERIMENT=1 go test ./p2p/ +``` From cb5c52042b74a24e503cad3692328bdcfe434e53 Mon Sep 17 00:00:00 2001 From: David Dias Date: Wed, 18 Nov 2015 16:42:07 +0000 Subject: [PATCH 2/6] add roadmap and make uniform with the remaining libp2p implementations --- README.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 66 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 35db1798..7b56b165 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,18 @@ -# [libp2p](https://github.com/ipfs/specs/tree/master/libp2p) implementation in Go. +[libp2p](https://github.com/ipfs/specs/tree/master/libp2p) 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/ipfs/go-libp2p) [![Build Status](https://travis-ci.org/ipfs/go-libp2p.svg?branch=master)](https://travis-ci.org/ipfs/go-libp2p) -> [libp2p](https://github.com/ipfs/specs/tree/master/libp2p) 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 implementation in Go + +# Description + +[libp2p](https://github.com/ipfs/specs/tree/master/libp2p) 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. +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 > @@ -15,8 +20,17 @@ > - [**go-libp2p implementation**](https://github.com/ipfs/go-libp2p) > - [**js-libp2p implementation**](https://github.com/diasdavid/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. + # 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. + ## Install ```bash @@ -29,3 +43,52 @@ $ go get github.com/ipfs/go-libp2p $ cd $GOPATH/src/github.com/ipfs/go-libp2p $ GO15VENDOREXPERIMENT=1 go test ./p2p/ ``` + +## Interface + +# Modules + +- [libp2p](https://github.com/diasdavid/rust-libp2p) (entry point) +- **Swarm** + - [libp2p-swarm]() + - [libp2p-identify]() + - [libp2p-ping]() + - Transports + - [abstract-transport](https://github.com/diasdavid/abstract-transport) + - [abstract-connection](https://github.com/diasdavid/abstract-connection) + - [libp2p-tcp]() + - [libp2p-udp]() + - [libp2p-udt]() + - [libp2p-utp]() + - [libp2p-webrtc]() + - [libp2p-cjdns]() + - Stream Muxing + - [abstract-stream-muxer](https://github.com/diasdavid/abstract-stream-muxer) + - [libp2p-spdy]() + - [libp2p-multiplex]() + - Crypto Channel + - [libp2p-tls]() + - [libp2p-secio]() +- **Peer Routing** + - [libp2p-kad-routing]() + - [libp2p-mDNS-routing]() +- **Discovery** + - [libp2p-mdns-discovery]() + - [libp2p-random-walk]() + - [libp2p-railing]() +- **Distributed Record Store** + - [libp2p-record]() + - [abstract-record-store](https://github.com/diasdavid/abstract-record-store) + - [libp2p-distributed-record-store]() + - [libp2p-kad-record-store]() +- **Generic** + - [PeerInfo]() + - [PeerId]() + - [multihash]() + - [multiaddr]() + - [multistream]() + - [multicodec]() + - [ipld]() + - [repo]() +- [**Specs**](https://github.com/ipfs/specs/tree/master/protocol/network) +- [**Website**](https://github.com/diasdavid/libp2p-website) From b1177c0d2fc2ed3486d9193b06ae55477f549c29 Mon Sep 17 00:00:00 2001 From: David Dias Date: Wed, 18 Nov 2015 18:29:13 +0000 Subject: [PATCH 3/6] remove rust ref --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b56b165..e3b7dbd6 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ $ GO15VENDOREXPERIMENT=1 go test ./p2p/ # Modules -- [libp2p](https://github.com/diasdavid/rust-libp2p) (entry point) +- [libp2p](https://github.com/ipfs/go-libp2p) (entry point) - **Swarm** - [libp2p-swarm]() - [libp2p-identify]() From 35a0ea39a32b565fc4a84e9cdcaf777d4000154c Mon Sep 17 00:00:00 2001 From: David Dias Date: Thu, 19 Nov 2015 10:30:41 +0000 Subject: [PATCH 4/6] remove _test.go --- .gitignore | 1 + README.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 1377554e..fbf50087 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ *.swp +vendor diff --git a/README.md b/README.md index e3b7dbd6..54145983 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ $ go get github.com/ipfs/go-libp2p ```bash $ cd $GOPATH/src/github.com/ipfs/go-libp2p -$ GO15VENDOREXPERIMENT=1 go test ./p2p/ +$ GO15VENDOREXPERIMENT=1 go test ./p2p/ ``` ## Interface From 7f7b76d39c8e9360cc7e0700a928e587eaf05da9 Mon Sep 17 00:00:00 2001 From: David Dias Date: Thu, 19 Nov 2015 10:32:30 +0000 Subject: [PATCH 5/6] add -u on install things --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 54145983..4d0d63d7 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ libp2p implementation in Go is a work in progress. As such, there's a few things ## Install ```bash -$ go get github.com/ipfs/go-libp2p +$ go get -u github.com/ipfs/go-libp2p ``` # Run tests From c7f397babbe8fbe89c2acad9ce261163a411cddb Mon Sep 17 00:00:00 2001 From: David Dias Date: Thu, 19 Nov 2015 10:39:01 +0000 Subject: [PATCH 6/6] add logo --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 4d0d63d7..d6ad85c2 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ [![GoDoc](https://godoc.org/github.com/ipfs/go-libp2p?status.svg)](https://godoc.org/github.com/ipfs/go-libp2p) [![Build Status](https://travis-ci.org/ipfs/go-libp2p.svg?branch=master)](https://travis-ci.org/ipfs/go-libp2p) +![](https://raw.githubusercontent.com/diasdavid/specs/libp2p-spec/protocol/network/figs/logo.png) + > libp2p implementation in Go # Description