Commit 9a46f7ef authored by Richard Littauer's avatar Richard Littauer
Browse files

Updated README

parent 5ef0524f
# libp2p # go-libp2p
![](https://raw.githubusercontent.com/diasdavid/specs/libp2p-spec/protocol/network/figs/logo.png) ![](https://raw.githubusercontent.com/libp2p/libp2p/master/img/logo.png)
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) [![](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)](https://webchat.freenode.net/?channels=%23ipfs) [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](https://webchat.freenode.net/?channels=%23ipfs)
[![](https://img.shields.io/badge/project-libp2p-blue.svg?style=flat-square)](http://github.com/libp2p/libp2p) [![](https://img.shields.io/badge/project-libp2p-blue.svg?style=flat-square)](https://github.com/libp2p/libp2p)
[![](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) [![](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
[![GoDoc](https://godoc.org/github.com/ipfs/go-libp2p?status.svg)](https://godoc.org/github.com/libp2p/go-libp2p) [![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) [![Build Status](https://travis-ci.org/ipfs/go-libp2p.svg?branch=master)](https://travis-ci.org/libp2p/go-libp2p)
...@@ -18,8 +18,8 @@ libp2p is the product of a long and arduous quest of understanding -- a deep div ...@@ -18,8 +18,8 @@ libp2p is the product of a long and arduous quest of understanding -- a deep div
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: 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/ipfs/specs/tree/master/libp2p), which grew into libp2p - [**The IPFS Network Spec**](https://github.com/ipfs/specs/tree/master/libp2p), which grew into libp2p
- [**go-libp2p implementation**](https://github.com/ipfs/go-libp2p) - [**go-libp2p implementation**](https://github.com/libp2p/go-libp2p)
- [**js-libp2p implementation**](https://github.com/diasdavid/js-libp2p) - [**js-libp2p implementation**](https://github.com/libp2p/js-libp2p)
## Table of Contents ## Table of Contents
...@@ -111,23 +111,23 @@ We want to maintain history, so we'll use git-subtree for extracting packages. ...@@ -111,23 +111,23 @@ We want to maintain history, so we'll use git-subtree for extracting packages.
> git push origin master > git push origin master
``` ```
## Maintainers
Captain: [@whyrusleeping](https://github.com/whyrusleeping)
## Contribute ## 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: 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. - Go through the modules below and [**check out existing issues**](https://github.com/libp2p/go-libp2p/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**. - **Perform code reviews**.
- **Add tests**. There can never be enough tests. - **Add tests**. There can never be enough tests.
Feel free to join in. All are welcome. Open an [issue](https://github.com/ipfs/go-libp2p-crypto/issues)! Feel free to join in. All are welcome. Open an [issue](https://github.com/libp2p/go-libp2p-crypto/issues)!
Check out our [contributing document](https://github.com/libp2p/community/blob/master/CONTRIBUTE.md) for more information on how we work, and about contributing in general. Please be aware that all interactions related to libp2p are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). Check out our [contributing document](https://github.com/libp2p/community/blob/master/CONTRIBUTE.md) for more information on how we work, and about contributing in general. Please be aware that all interactions related to libp2p are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification. Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
### Want to hack on IPFS?
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
## License ## License
[MIT](LICENSE) [MIT](LICENSE) © 2014 Juan Batiz-Benet
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment