git ssb - more docs · Dominic/pull-stream@019de9e4

Dominic Tarr committed on 6/1/2016, 1:32:39 AM
Parent: 81642b10bd4a0105dae4a0d01429420d3ddb2016

changed

README.mdView
		@@ -26,19 +26,25 @@
26	26	)
27	27	```
28	28	note that `pull(a, b, c)` is basically the same as `a.pipe(b).pipe(c)`.
29	29
30		-The best thing about pull-stream is that it can be completely lazy.
31		-This is perfect for async traversals where you might want to stop early.
	30	+to grok how pull-streams work, read through [pull-streams by example](https://github.com/dominictarr/pull-stream-examples)
32	31
	32	+## How do I do X with pull-streams?
	33	+
	34	+There is a module for that!
	35	+
	36	+Check the [pull-stream FAQ](https://github.com/pull-stream/pull-stream-faq)
	37	+and post an issue if you have a question that is not on that.
	38	+
33	39	## Compatibily with node streams
34	40
35	41	pull-streams are not _directly_ compatible with node streams,
36	42	but pull-streams can be converted into node streams with
37	43	[pull-stream-to-stream](https://github.com/dominictarr/pull-stream-to-stream)
38	44	and node streams can be converted into pull-stream using [stream-to-pull-stream](https://github.com/dominictarr/stream-to-pull-stream)
	45	+correct back pressure is preserved.
39	46
40		-
41	47	### Readable & Reader vs. Readable & Writable
42	48
43	49	Instead of a readable stream, and a writable stream, there is a `readable` stream,
44	50	(aka "Source") and a `reader` stream (aka "Sink"). Through streams
		@@ -313,4 +319,5 @@
313	319
314	320	## License
315	321
316	322	MIT
	323	+

Dominic / pull-stream