Summer cleaning #216

daviddias · 2017-08-19T16:20:31Z

…add new logo, make it match js-libp2p

daviddias · 2017-08-19T16:25:39Z

Stebalien

🙇‍♂️

Stebalien · 2017-08-19T21:49:27Z

README.md


 [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
+> - [**The libp2p Specification**](https://github.com/libp2p/specs), which grew into libp2p


I'd remove the "which grew into libp2p" part (only makes sense when we call it the "IPFS Network Spec").

Stebalien · 2017-08-19T21:51:06Z

README.md


-# Usage
+There is currently only one bundle of `go-libp2p`, this package. This bundle is used by [`go-ipfs`](https://github.com/ipfs/go-ipfs).


Does this statement really serve any purpose?

We mention bundles on the website and the JavaScript version. I know that right now everything gets a bit hardcoded in go-libp2p, but ideally we would be able to create multiple bundles with different features easily (think different runtimes)

Stebalien · 2017-08-19T21:51:32Z

README.md

-# Usage
+There is currently only one bundle of `go-libp2p`, this package. This bundle is used by [`go-ipfs`](https://github.com/ipfs/go-ipfs).
+
+## 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.


s/will be/is

Stebalien · 2017-08-19T21:52:54Z

README.md

+
+### Dependencies
+
+While developing, you need to use gx to install and link your dependencies, to do that, run:


Do we have some explanation of gx we can link to. If you don't know what gx is, this instruction will be very confusing.

Stebalien · 2017-08-19T21:53:21Z

README.md

+
+### Tests
+
+Running of individual tests is done through `go test <path to test>`


If we're going to give people gx instructions, we might as well tell them to run gx test ...

I'd tell users to call gx test here as well.

Stebalien · 2017-08-19T21:57:01Z

README.md

- [**Website**](https://github.com/libp2p/website)
+| Package            | Version | CI                  |
+|--------------------|---------|---------------------|
+| **Transports**                                     |


I assume this section is WIP.

It is indeed

Can we add a "(WIP)" marker here. Otherwise, this is a bit confusing.

Stebalien · 2017-08-19T21:57:57Z

README.md

+
+- read the [libp2p spec](https://github.com/libp2p/specs)
+- 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.


We should update this (and any other documents that tell users to do this).

Stebalien · 2017-08-19T22:00:04Z

TODO

@@ -1 +1 @@
- pull mdns out as its own separate package
+- [ ] pull mdns out as its own separate package


I'd just remove this file and file an issue.

Stebalien · 2017-08-19T22:12:36Z

examples/http-proxy/README.md

@@ -46,7 +43,7 @@ libp2p-peer addresses:
 The run the local peer, indicating that it will need to forward http requests to the remote peer as follows:

 ```
-$ ./http-proxy -d /ip4/127.0.0.1/tcp/12000/ipfs/QmddTrQXhA9AkCpXPTkcY7e22NK73TwkUms3a44DhTKJTD
+> ./http-proxy -d /ip4/127.0.0.1/tcp/12000/ipfs/QmddTrQXhA9AkCpXPTkcY7e22NK73TwkUms3a44DhTKJTD


Any particular reason for this change? Historically, $ has meant "prompt where user is not root" and # has meant "prompt where user is root".

There was a conversation a long time ago between Juan and Richard where they questioned what was the most valid character to represent the prompt and the result of the conversation was >.

As for #, we use it everywhere as comments since it is the character for line comments in bash.

(:roll_eyes:) Unfortunately, that argument kind of makes sense. $ for variables, # for comments, > for prompts.

But really,

𝝺: echo "there can be only one"

ahaha :)

can this get merged then?

daviddias · 2017-08-20T19:06:13Z

Thanks for the review @Stebalien :)

daviddias · 2017-08-21T10:01:41Z

Can this be merged? :)

Stebalien

(with nits)

Stebalien · 2017-08-21T19:49:32Z

README.md

+
+### Tests
+
+Running of individual tests is done through `go test <path to test>`


I'd tell users to call gx test here as well.

Stebalien · 2017-08-21T19:50:27Z

README.md

- [**Website**](https://github.com/libp2p/website)
+| Package            | Version | CI                  |
+|--------------------|---------|---------------------|
+| **Transports**                                     |


Can we add a "(WIP)" marker here. Otherwise, this is a bit confusing.

Stebalien · 2017-08-21T19:51:55Z

README.md

+| **Crypto Channels**                                |
+| **Peer Routing**                                   |
+| **Content Routing**                                |
+| **Generics**                                       |


What do you mean by "generics". To me, "generics" usually means something like Java generics but go doesn't have those...

fair point, specially with all the discussion about generics in go land. Renamed to Miscellaneous, it is the packages that don't fit a specific category.

Stebalien · 2017-08-21T20:12:01Z

💖

close all UDP connections when the reuse is closed

daviddias added 5 commits August 19, 2017 17:55

docs: refresh the readme, add more information for new contributors, …

c7ad187

…add new logo, make it match js-libp2p

docs(examples): reorganize examples and tutorials, add an index

564e2ba

docs: add a note about gxifying deps

b2d738a

docs(examples): small refresh to the echo example

a8926ed

docs(examples): give a pass through remaining examples

2c7c62e

daviddias added the status/in-progress In progress label Aug 19, 2017

daviddias requested review from whyrusleeping, Stebalien and Kubuxu August 19, 2017 16:20

docs: remove coverage badge (non existent)

e7293cb

daviddias mentioned this pull request Aug 19, 2017

libp2p spec link in CONTRIBUTE is a broken link. #41

Closed

Stebalien reviewed Aug 19, 2017

View reviewed changes

daviddias mentioned this pull request Aug 20, 2017

pull mdns out as its own separate package #217

Closed

apply cr

4cc6a4e

Stebalien approved these changes Aug 21, 2017

View reviewed changes

apply cr

3d33ba1

Stebalien merged commit c50d6f5 into master Aug 21, 2017

daviddias removed the status/in-progress In progress label Aug 21, 2017

daviddias deleted the feat/summer-cleaning branch August 21, 2017 20:14

daviddias mentioned this pull request Aug 21, 2017

go-libp2p documentation effort #186

Closed

marten-seemann added a commit that referenced this pull request Apr 22, 2022

Merge pull request #216 from libp2p/close-conns-on-reuse-close

fefca49

close all UDP connections when the reuse is closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Summer cleaning #216

Summer cleaning #216

daviddias commented Aug 19, 2017

daviddias commented Aug 19, 2017

Stebalien left a comment

Stebalien Aug 19, 2017

Stebalien Aug 19, 2017

daviddias Aug 20, 2017

Stebalien Aug 19, 2017

Stebalien Aug 19, 2017

Stebalien Aug 19, 2017

Stebalien Aug 21, 2017

Stebalien Aug 19, 2017

daviddias Aug 20, 2017

Stebalien Aug 21, 2017

Stebalien Aug 19, 2017

Stebalien Aug 19, 2017

Stebalien Aug 19, 2017

daviddias Aug 20, 2017

Stebalien Aug 20, 2017

daviddias Aug 20, 2017

daviddias commented Aug 20, 2017

daviddias commented Aug 21, 2017

Stebalien left a comment

Stebalien Aug 21, 2017

Stebalien Aug 21, 2017

Stebalien Aug 21, 2017

daviddias Aug 21, 2017

Stebalien commented Aug 21, 2017


		# Usage
		There is currently only one bundle of `go-libp2p`, this package. This bundle is used by [`go-ipfs`](https://github.com/ipfs/go-ipfs).


		### Dependencies

		While developing, you need to use gx to install and link your dependencies, to do that, run:


		### Tests

		Running of individual tests is done through `go test <path to test>`

		@@ -1 +1 @@
		- pull mdns out as its own separate package
		- [ ] pull mdns out as its own separate package

Summer cleaning #216

Summer cleaning #216

Conversation

daviddias commented Aug 19, 2017

daviddias commented Aug 19, 2017

Stebalien left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daviddias commented Aug 20, 2017

daviddias commented Aug 21, 2017

Stebalien left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Stebalien commented Aug 21, 2017