mirror of https://github.com/libp2p/go-libp2p.git
Juan Batiz-Benet
9 years ago
3 changed files with 56 additions and 0 deletions
@ -0,0 +1,15 @@ |
|||
# 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/ipfs/specs/tree/master/protocol/network) |
|||
- please make branches + pull-request, even if working on the main repository |
|||
- ask questions or talk about things in [Issues](https://github.com/ipfs/go-ipfs/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! |
|||
@ -0,0 +1,21 @@ |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2014 Juan Batiz-Benet |
|||
|
|||
Permission is hereby granted, free of charge, to any person obtaining a copy |
|||
of this software and associated documentation files (the "Software"), to deal |
|||
in the Software without restriction, including without limitation the rights |
|||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|||
copies of the Software, and to permit persons to whom the Software is |
|||
furnished to do so, subject to the following conditions: |
|||
|
|||
The above copyright notice and this permission notice shall be included in |
|||
all copies or substantial portions of the Software. |
|||
|
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
|||
THE SOFTWARE. |
|||
@ -0,0 +1,20 @@ |
|||
# [libp2p](https://github.com/ipfs/specs/tree/master/libp2p) implementation in Go. |
|||
|
|||
[](http://ipn.io) |
|||
[[](http://webchat.freenode.net/?channels=%23ipfs) |
|||
[](https://godoc.org/github.com/ipfs/go-libp2p) |
|||
[](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) 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. But in the meantime, check out |
|||
> |
|||
> - [**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) |
|||
|
|||
## This README is WIP |
|||
|
|||
Loading…
Reference in new issue