Galerie und tage

node_modules/decompress-targz/readme.md

@@ -1,43 +1,56 @@
-# decompress-targz [![Build Status](https://travis-ci.org/kevva/decompress-targz.svg?branch=master)](https://travis-ci.org/kevva/decompress-targz)
+# decompress-targz [![Build Status](http://img.shields.io/travis/kevva/decompress-targz.svg?style=flat)](https://travis-ci.org/kevva/decompress-targz)
 
 > tar.gz decompress plugin
 
-
 ## Install
 
+```sh
+$ npm install --save decompress-targz
 ```
-$ npm install decompress-targz
-```
-
 
 ## Usage
 
 ```js
-const decompress = require('decompress');
-const decompressTargz = require('decompress-targz');
+var Decompress = require('decompress');
+var targz = require('decompress-targz');
 
-decompress('unicorn.tar.gz', 'dist', {
-	plugins: [
-		decompressTargz()
-	]
-}).then(() => {
-	console.log('Files decompressed');
+var decompress = new Decompress()
+	.src('foo.tar.gz')
+	.dest('dest')
+	.use(targz({strip: 1}));
+
+decompress.run(function (err, files) {
+	if (err) {
+		throw err;
+	}
+
+	console.log('Files extracted successfully!'); 
 });
 ```
 
+You can also use this plugin with [gulp](http://gulpjs.com):
 
-## API
+```js
+var gulp = require('gulp');
+var targz = require('decompress-targz');
+var vinylAssign = require('vinyl-assign');
 
-### decompressTargz()(input)
+gulp.task('default', function () {
+	return gulp.src('foo.tar.gz')
+		.pipe(vinylAssign({extract: true}))
+		.pipe(targz({strip: 1}))
+		.pipe(gulp.dest('dest'));
+});
+```
 
-Returns both a Promise for a Buffer and a [Duplex stream](https://nodejs.org/api/stream.html#stream_class_stream_duplex).
+## Options
 
-#### input
+### strip
 
-Type: `Buffer` `Stream`
-
-Buffer or stream to decompress.
+Type: `Number`  
+Default: `0`
 
+Equivalent to `--strip-components` for tar.
 
 ## License