Standardized Readme #72
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
||
| # 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. |
There was a problem hiding this comment.
why did you put this all into one line?
There was a problem hiding this comment.
It was already in one line?
|
@whyrusleeping Word on this? |
hsanjuan
reviewed
Oct 5, 2016
|
|
||
| `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 [libp2p-examples repo](https://github.com/whyrusleeping/libp2p-examples/) |
There was a problem hiding this comment.
LGTM, I'm already a fan of your standarized readmes :)
RichardLitt
force-pushed
the
feature/standardize-readme
branch
from
d753632
to
fd536fc
Compare
RichardLitt
force-pushed
the
feature/standardize-readme
branch
from
017656d
to
8f4d370
Compare
ghost
reviewed
Jan 6, 2017
| =================== | ||
| # go-libp2p | ||
|
|
||
|  |
There was a problem hiding this comment.
The logo should be moved into this repo here
ghost
reviewed
Jan 6, 2017
| # Usage | ||
| - [**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) | ||
| - [**js-libp2p implementation**](https://github.com/diasdavid/js-libp2p) |
There was a problem hiding this comment.
needs to point to libp2p/specs and libp2p/js-libp2p respectively
RichardLitt
force-pushed
the
feature/standardize-readme
branch
from
8f4d370
to
0b3bf4a
Compare
RichardLitt
force-pushed
the
feature/standardize-readme
branch
from
0b3bf4a
to
9a46f7e
Compare
|
@lgierth fixed. |
ghost
reviewed
Jan 7, 2017
| ## 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. |
There was a problem hiding this comment.
should either remove the go-libp2p reference or also mention js-libp2p
There was a problem hiding this comment.
It should only mention go!
|
@lgierth This should be good to go, no? |
|
@whyrusleeping Apparently you're the merge master for this one. |
|
I believe this one can be closed. The README got a summer cleaning today :) |
marten-seemann
pushed a commit
that referenced
this pull request
Jan 17, 2022
marten-seemann
pushed a commit
that referenced
this pull request
Apr 21, 2022
limiter: cleanup the code
marten-seemann
added a commit
that referenced
this pull request
Apr 22, 2022
…-net stop using the deprecated go-multiaddr-net package
marten-seemann
added a commit
that referenced
this pull request
Apr 26, 2022
stop using the deprecated go-multiaddr-net
marten-seemann
pushed a commit
that referenced
this pull request
Aug 9, 2022
fix unmarshalling of peer IDs
marten-seemann
pushed a commit
that referenced
this pull request
Aug 15, 2022
Record which direction the resource was blocked
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See ipfs/community#124