diff options
Diffstat (limited to 'node_modules/gulp-tar/readme.md')
| -rw-r--r-- | node_modules/gulp-tar/readme.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/node_modules/gulp-tar/readme.md b/node_modules/gulp-tar/readme.md new file mode 100644 index 000000000..47c213132 --- /dev/null +++ b/node_modules/gulp-tar/readme.md @@ -0,0 +1,48 @@ +# gulp-tar [](https://travis-ci.org/sindresorhus/gulp-tar) + +> Create [tarball](http://en.wikipedia.org/wiki/Tar_(computing)) from files + + +## Install + +``` +$ npm install --save-dev gulp-tar +``` + + +## Usage + +```js +const gulp = require('gulp'); +const tar = require('gulp-tar'); +const gzip = require('gulp-gzip'); + +gulp.task('default', () => + gulp.src('src/*') + .pipe(tar('archive.tar')) + .pipe(gzip()) + .pipe(gulp.dest('dist')) +); +``` + + +## API + +### tar(filename, [options]) + +#### filename + +Type: `string` + +Filename for the output tar archive. + +#### options + +Type: `object` + +Default file headers passed to [tar-stream](https://github.com/mafintosh/tar-stream). + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |