diff options
Diffstat (limited to 'node_modules/gulp-zip/readme.md')
-rw-r--r-- | node_modules/gulp-zip/readme.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/node_modules/gulp-zip/readme.md b/node_modules/gulp-zip/readme.md new file mode 100644 index 000000000..ad01564f9 --- /dev/null +++ b/node_modules/gulp-zip/readme.md @@ -0,0 +1,47 @@ +# gulp-zip [](https://travis-ci.org/sindresorhus/gulp-zip) + +> ZIP compress files + + +## Install + +``` +$ npm install --save-dev gulp-zip +``` + + +## Usage + +```js +const gulp = require('gulp'); +const zip = require('gulp-zip'); + +gulp.task('default', () => { + return gulp.src('src/*') + .pipe(zip('archive.zip')) + .pipe(gulp.dest('dist')); +}); +``` + + +## API + +Supports [streaming mode](https://github.com/gulpjs/gulp/blob/master/docs/API.md#optionsbuffer). + +### zip(filename, options) + +#### filename + +Type: `string` + +#### options + +##### compress + +Type: `boolean`<br> +Default: `true` + + +## License + +MIT © [Sindre Sorhus](http://sindresorhus.com) |