diff options
Diffstat (limited to 'node_modules/archiver/README.md')
| -rw-r--r-- | node_modules/archiver/README.md | 28 |
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
+
+[](https://travis-ci.org/archiverjs/node-archiver) [](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 |