aboutsummaryrefslogtreecommitdiff
path: root/node_modules/decompress-unzip/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/decompress-unzip/readme.md')
-rw-r--r--node_modules/decompress-unzip/readme.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/node_modules/decompress-unzip/readme.md b/node_modules/decompress-unzip/readme.md
new file mode 100644
index 0000000..b03f25f
--- /dev/null
+++ b/node_modules/decompress-unzip/readme.md
@@ -0,0 +1,42 @@
+# decompress-unzip [![Build Status](https://travis-ci.org/kevva/decompress-unzip.svg?branch=master)](https://travis-ci.org/kevva/decompress-unzip)
+
+> zip decompress plugin
+
+
+## Install
+
+```
+$ npm install --save decompress-unzip
+```
+
+
+## Usage
+
+```js
+const decompress = require('decompress');
+const decompressUnzip = require('decompress-unzip');
+
+decompress('unicorn.zip', 'dist', {
+ plugins: [
+ decompressUnzip()
+ ]
+}).then(() => {
+ console.log('Files decompressed');
+});
+```
+
+
+## API
+
+### decompressUnzip()(buf)
+
+#### buf
+
+Type: `Buffer`
+
+Buffer to decompress.
+
+
+## License
+
+MIT © [Kevin Mårtensson](https://github.com/kevva)