docs: add yamux install instructions to GETTING_STARTED.md #2124
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
if yamux is used, it needs to be installed
maschad
requested changes
Oct 4, 2023
There was a problem hiding this comment.
Thanks for opening this, we are actually in the process of deprecating mplex and so I think the Multiplexing section should reflect that. Could you make those changes please so that we could land this?
| @@ -126,7 +126,7 @@ Looking at the [available stream multiplexing](./CONFIGURATION.md#stream-multipl | |||
| You can install `@libp2p/mplex` and add it to your libp2p node as follows in the next example. | |||
|
|
|||
| ```sh | |||
| npm install @libp2p/mplex | |||
| npm install @libp2p/mplex @chainsafe/libp2p-yamux | |||
There was a problem hiding this comment.
Suggested change
| npm install @libp2p/mplex @chainsafe/libp2p-yamux | |
| npm install @chainsafe/libp2p-yamux |
| @@ -126,7 +126,7 @@ Looking at the [available stream multiplexing](./CONFIGURATION.md#stream-multipl | |||
| You can install `@libp2p/mplex` and add it to your libp2p node as follows in the next example. | |||
There was a problem hiding this comment.
This and the Multiplexing section above makes references to @libp2p/mplex which are actually going to be outdated, we should update this to yamux
achingbrain
changed the title
achingbrain
force-pushed
the
main
branch
24 times, most recently
from
ae05a4d
to
dea0d8e
Compare
achingbrain
force-pushed
the
main
branch
13 times, most recently
from
242fd96
to
bca8d6e
Compare
|
Closing as this |
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.
if yamux is used, it needs to be installed