diff options
Diffstat (limited to 'node_modules/gulp-tar/readme.md')
| -rw-r--r-- | node_modules/gulp-tar/readme.md | 48 |
1 files changed, 0 insertions, 48 deletions
diff --git a/node_modules/gulp-tar/readme.md b/node_modules/gulp-tar/readme.md deleted file mode 100644 index 5b036443a..000000000 --- a/node_modules/gulp-tar/readme.md +++ /dev/null @@ -1,48 +0,0 @@ -# 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 options passed to [Archiver](https://github.com/archiverjs/node-archiver)'s [constructor](https://archiverjs.com/docs/Archiver.html) and merged into the [data](https://archiverjs.com/docs/global.html#TarEntryData) passed to its [`append`](https://archiverjs.com/docs/Archiver.html#append) method. - - -## License - -MIT © [Sindre Sorhus](https://sindresorhus.com) |