Galerie und tage

node_modules/decompress-tarbz2/readme.md

@@ -1,43 +1,56 @@
-# decompress-tarbz2 [![Build Status](https://travis-ci.org/kevva/decompress-tarbz2.svg?branch=master)](https://travis-ci.org/kevva/decompress-tarbz2)
+# decompress-tarbz2 [![Build Status](http://img.shields.io/travis/kevva/decompress-tarbz2.svg?style=flat)](https://travis-ci.org/kevva/decompress-tarbz2)
 
 > tar.bz2 decompress plugin
 
-
 ## Install
 
+```sh
+$ npm install --save decompress-tarbz2
 ```
-$ npm install decompress-tarbz2
-```
-
 
 ## Usage
 
 ```js
-const decompress = require('decompress');
-const decompressTarbz = require('decompress-tarbz2');
+var Decompress = require('decompress');
+var tarbz2 = require('decompress-tarbz2');
 
-decompress('unicorn.tar.gz', 'dist', {
-	plugins: [
-		decompressTarbz()
-	]
-}).then(() => {
-	console.log('Files decompressed');
+var decompress = new Decompress()
+	.src('foo.tar.bz2')
+	.dest('dest')
+	.use(tarbz2({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 tarbz2 = require('decompress-tarbz2');
+var vinylAssign = require('vinyl-assign');
 
-### decompressTarbz()(input)
+gulp.task('default', function () {
+	return gulp.src('foo.tar.bz2')
+		.pipe(vinylAssign({extract: true}))
+		.pipe(tarbz2({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 to decompress.
+Type: `Number`  
+Default: `0`
 
+Equivalent to `--strip-components` for tar.
 
 ## License