Skip to content
This repository was archived by the owner on Jan 15, 2025. It is now read-only.

Commit 3baa2b6

Browse files
committed
improve docs
1 parent 6dcf467 commit 3baa2b6

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ npm install tar-fs
1212

1313
tar-fs allows you to pack directories into tarballs and extract tarballs into directories.
1414

15+
It doesn't gunzip for you, so if you want to extract a `.tar.gz` with this you'll need to use something like [gunzip-maybe](https://github.com/mafintosh/gunzip-maybe) in addition to this.
16+
1517
``` js
1618
var tar = require('tar-fs')
1719
var fs = require('fs')
@@ -23,7 +25,7 @@ tar.pack('./my-directory').pipe(fs.createWriteStream('my-tarball.tar'))
2325
fs.createReadStream('my-other-tarball.tar').pipe(tar.extract('./my-other-directory'))
2426
```
2527

26-
To ignore various files when packing or extracting add a ignore function to the options
28+
To ignore various files when packing or extracting add a ignore function to the options. `ignore` is also an alias for `filter`.
2729

2830
``` js
2931
var pack = tar.pack('./my-directory', {

0 commit comments

Comments
 (0)