Galerie und tage

node_modules/decompress-unzip/readme.md

@@ -13,28 +13,42 @@ $ npm install --save decompress-unzip
 ## Usage
 
 ```js
-const decompress = require('decompress');
+const Decompress = require('decompress');
 const decompressUnzip = require('decompress-unzip');
 
-decompress('unicorn.zip', 'dist', {
-	plugins: [
-		decompressUnzip()
-	]
-}).then(() => {
-	console.log('Files decompressed');
+new Decompress()
+	.src('foo.zip')
+	.dest('dest')
+	.use(decompressUnzip({strip: 1}))
+	.run();
+```
+
+You can also use this plugin with [gulp](http://gulpjs.com):
+
+```js
+const decompressUnzip = require('decompress-unzip');
+const gulp = require('gulp');
+const vinylAssign = require('vinyl-assign');
+
+gulp.task('default', () => {
+	return gulp.src('foo.zip')
+		.pipe(vinylAssign({extract: true}))
+		.pipe(decompressUnzip({strip: 1}))
+		.pipe(gulp.dest('dest'));
 });
 ```
 
 
 ## API
 
-### decompressUnzip()(buf)
+### decompressUnzip(options)
 
-#### buf
+#### options.strip
 
-Type: `Buffer`
+Type: `number`  
+Default: `0`
 
-Buffer to decompress.
+Remove leading directory components from extracted files.
 
 
 ## License