aboutsummaryrefslogtreecommitdiff
path: root/node_modules/gulp-tar/readme.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2016-10-10 03:43:44 +0200
committerFlorian Dold <florian.dold@gmail.com>2016-10-10 03:43:44 +0200
commitabd94a7f5a50f43c797a11b53549ae48fff667c3 (patch)
treeab8ed457f65cdd72e13e0571d2975729428f1551 /node_modules/gulp-tar/readme.md
parenta0247c6a3fd6a09a41a7e35a3441324c4dcb58be (diff)
add node_modules to address #4364
Diffstat (limited to 'node_modules/gulp-tar/readme.md')
-rw-r--r--node_modules/gulp-tar/readme.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/node_modules/gulp-tar/readme.md b/node_modules/gulp-tar/readme.md
new file mode 100644
index 000000000..47c213132
--- /dev/null
+++ b/node_modules/gulp-tar/readme.md
@@ -0,0 +1,48 @@
+# gulp-tar [![Build Status](https://travis-ci.org/sindresorhus/gulp-tar.svg?branch=master)](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 file headers passed to [tar-stream](https://github.com/mafintosh/tar-stream).
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)