aboutsummaryrefslogtreecommitdiff
path: root/node_modules/archiver/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/archiver/README.md
parenta0247c6a3fd6a09a41a7e35a3441324c4dcb58be (diff)
downloadwallet-core-abd94a7f5a50f43c797a11b53549ae48fff667c3.tar.xz
add node_modules to address #4364
Diffstat (limited to 'node_modules/archiver/README.md')
-rw-r--r--node_modules/archiver/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/node_modules/archiver/README.md b/node_modules/archiver/README.md
new file mode 100644
index 000000000..f90c938d4
--- /dev/null
+++ b/node_modules/archiver/README.md
@@ -0,0 +1,28 @@
+# Archiver v1.1.0
+
+[![Build Status](https://travis-ci.org/archiverjs/node-archiver.svg?branch=master)](https://travis-ci.org/archiverjs/node-archiver) [![Build status](https://ci.appveyor.com/api/projects/status/38kqu3yp159nodxe/branch/master?svg=true)](https://ci.appveyor.com/project/ctalkington/node-archiver/branch/master)
+
+a streaming interface for archive generation
+
+Visit the [API documentation](http://archiverjs.com/docs) for a list of all methods available.
+
+## Install
+
+```bash
+npm install archiver --save
+```
+
+## Usage
+
+```js
+var archiver = require('archiver');
+var archive = archiver.create('zip', {}); // or archiver('zip', {});
+```
+
+## Formats
+
+Archiver ships with out of the box support for TAR and ZIP archives.
+
+You can register additional formats with `registerFormat`.
+
+_Formats will be changing in the next few releases to implement a middleware approach._ \ No newline at end of file