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

Add link to tar-fs in a related section. Fixes #20

Browse source
This commit is contained in:
Mathias Buus 2014-07-28 14:12:08 +02:00
parent c37042f3e8
commit e1ac6a06ec
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -10,6 +10,10 @@ tar-stream is a streaming tar parser and generator and nothing else. It is strea
tar-stream exposes two streams, [pack](https://github.com/mafintosh/tar-stream#packing) which creates tarballs and [extract](https://github.com/mafintosh/tar-stream#extracting) which extracts tarballs. To [modify an existing tarball](https://github.com/mafintosh/tar-stream#modifying-existing-tarballs) use both. tar-stream exposes two streams, [pack](https://github.com/mafintosh/tar-stream#packing) which creates tarballs and [extract](https://github.com/mafintosh/tar-stream#extracting) which extracts tarballs. To [modify an existing tarball](https://github.com/mafintosh/tar-stream#modifying-existing-tarballs) use both.
## Related
If you want to pack/unpack directories on the file system check out [tar-fs](https://github.com/mafintosh/tar-fs) with provides file system bindings to this module
## Packing ## Packing
To create a pack stream use `tar.pack()` and call `pack.entry(header, [callback])` to add tar entries. To create a pack stream use `tar.pack()` and call `pack.entry(header, [callback])` to add tar entries.