From 42101400467632e94a6d82bfab0ca3541e81de37 Mon Sep 17 00:00:00 2001 From: Stephen Whitmore Date: Wed, 15 Jun 2016 11:42:33 -0700 Subject: [PATCH] Update README.md Mention the need to drain entry streams or else the main stream gets backpressure --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 3fb8418..be33c5e 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,8 @@ extract.on('finish', function() { pack.pipe(extract) ``` +The tar archive is streamed sequentially, meaning you **must** drain each entry's stream as you get them or else the main extract stream will receive backpressure and stop reading. + ## Headers The header object using in `entry` should contain the following properties.