Nulo/tar-stream
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

tweak examples

Browse source
This commit is contained in:
Mathias Buus 2014-10-01 17:54:16 -07:00
parent b51602478a
commit 50fb41809e
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -25,7 +25,7 @@ To create a pack stream use `tar.pack()` and call `pack.entry(header, [callback]
``` js ``` js
var tar = require('tar-stream') var tar = require('tar-stream')
var pack = tar.pack() // p is a streams2 stream var pack = tar.pack() // pack is a streams2 stream
// add a file called my-test.txt with the content "Hello World!" // add a file called my-test.txt with the content "Hello World!"
pack.entry({ name: 'my-test.txt' }, 'Hello World!') pack.entry({ name: 'my-test.txt' }, 'Hello World!')
@ -36,7 +36,8 @@ var entry = pack.entry({ name: 'my-stream-test.txt' }, function(err) {
// no more entries // no more entries
pack.finalize() pack.finalize()
}) })
myStream.pipe(entry)
someTarballStream.pipe(entry)
// pipe the pack stream somewhere // pipe the pack stream somewhere
pack.pipe(process.stdout) pack.pipe(process.stdout)
@ -114,10 +115,10 @@ extract.on('finish', function() {
}) })
// pipe the old tarball to the extractor // pipe the old tarball to the extractor
oldTarball.pipe(extract) oldTarballStream.pipe(extract)
// pipe the new tarball the another stream // pipe the new tarball the another stream
pack.pipe(newTarball) pack.pipe(newTarballStream)
``` ```
## Performance ## Performance