Add streaming iterables guide #459
Merged
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
doc/STREAMING_ITERABLES.md
Outdated
| @@ -0,0 +1,32 @@ | |||
| # Iterable Streams | |||
|
|
|||
| > This document is a guide on how to use Iterable Streams in Libp2p. As a part of the refactor away from callbacks, we have also moved to using Iterable Streams instead of [pull-streams](https://pull-stream.github.io/). If there are missing usage guides you feel should be added, please submit a PR! | |||
There was a problem hiding this comment.
Should we point the Issue here for context?
vasco-santos
approved these changes
Sep 30, 2019
dirkmc
pushed a commit
that referenced
this pull request
Nov 26, 2019
* docs: add streaming iterables guide placeholder * chore: move peer discovery readme to doc fold:wqer * docs: add link to async refactor issue
dirkmc
pushed a commit
that referenced
this pull request
Nov 26, 2019
* docs: add streaming iterables guide placeholder * chore: move peer discovery readme to doc fold:wqer * docs: add link to async refactor issue
jacobheun
added a commit
that referenced
this pull request
Dec 12, 2019
* docs: add streaming iterables guide placeholder * chore: move peer discovery readme to doc fold:wqer * docs: add link to async refactor issue
jacobheun
added a commit
that referenced
this pull request
Jan 24, 2020
* docs: add streaming iterables guide placeholder * chore: move peer discovery readme to doc fold:wqer * docs: add link to async refactor issue
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.
The usage section is currently blank, but I think getting this in sooner is best so that anyone can iterate on this. I am aiming to get some examples added in the next couple days.
I also moved the peer discovery readme since there is now a sub directory for docs.
Note: This is going into the async refactor branch