Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Standardized Readme #72

Closed
wants to merge 3 commits into from
Closed

Standardized Readme #72

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1259591
Standardized Readme
RichardLitt Jun 21, 2016
5ef0524
Edited contribute, libp2p link, license link
RichardLitt Oct 5, 2016
9a46f7e
Updated README
RichardLitt Jan 6, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
76 changes: 49 additions & 27 deletions README.md
View file
Open in desktop
@@ -1,37 +1,36 @@
[libp2p](https://github.com/libp2p/specs) implementation in Go.
===================
# go-libp2p

![](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/freenode-%23ipfs-blue.svg?style=flat-square)](http://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)](https://github.com/libp2p/libp2p)
[![](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)
[![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
> [libp2p](https://github.com/ipfs/specs/tree/master/libp2p) implementation in Go.

[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
> - [**go-libp2p implementation**](https://github.com/libp2p/go-libp2p)
> - [**js-libp2p implementation**](https://github.com/libp2p/js-libp2p)

# Contribute
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did you put this all into one line?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was already in one line?


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.
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:

# Usage
- [**The IPFS Network Spec**](https://github.com/ipfs/specs/tree/master/libp2p), which grew into libp2p
- [**go-libp2p implementation**](https://github.com/libp2p/go-libp2p)
- [**js-libp2p implementation**](https://github.com/libp2p/js-libp2p)

`go-libp2p` repo will be a place holder for the list of Go modules that compose Go libp2p, as well as its entry point.
## Table of Contents

- [Install](#install)
- [Usage](#usage)
- [Examples](#examples)
- [Run tests](#run-tests)
- [Links](#links)
- [Extracting packages from go-libp2p](#extracting-packages-from-go-libp2p)
- [Contribute](#contribute)
- [License](#license)

## Install

Expand All @@ -41,24 +40,26 @@ $ cd $GOPATH/src/github.com/libp2p/go-libp2p
$ make
```

# Examples
## 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.

## Examples

Examples can be found on the [examples folder](examples).

# Run tests
## Run tests

```bash
$ cd $GOPATH/src/github.com/libp2p/go-libp2p
$ make deps
$ go test ./p2p/<path of module you want to run tests for>
```


## Links
- [**Specs**](https://github.com/libp2p/specs)
- [**Website**](https://github.com/libp2p/website)


## Extracting packages from go-libp2p

We want to maintain history, so we'll use git-subtree for extracting packages.
Expand Down Expand Up @@ -109,3 +110,24 @@ We want to maintain history, so we'll use git-subtree for extracting packages.
> git remote rm libp2p
> git push origin master
```

## Maintainers

Captain: [@whyrusleeping](https://github.com/whyrusleeping)

## 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**](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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should either remove the go-libp2p reference or also mention js-libp2p

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should only mention go!

- **Perform code reviews**.
- **Add tests**. There can never be enough tests.

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).

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

[MIT](LICENSE) © 2014 Juan Batiz-Benet