aboutsummaryrefslogtreecommitdiff
path: root/node_modules/compress-commons/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/compress-commons/README.md')
-rw-r--r--node_modules/compress-commons/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/node_modules/compress-commons/README.md b/node_modules/compress-commons/README.md
new file mode 100644
index 000000000..258e68acc
--- /dev/null
+++ b/node_modules/compress-commons/README.md
@@ -0,0 +1,25 @@
+# Compress Commons v1.0.0 [![Build Status](https://travis-ci.org/archiverjs/node-compress-commons.svg?branch=master)](https://travis-ci.org/archiverjs/node-compress-commons) [![Build status](https://ci.appveyor.com/api/projects/status/fx3066dufdpar0it/branch/master?svg=true)](https://ci.appveyor.com/project/ctalkington/node-compress-commons/branch/master)
+
+Compress Commons is a library that defines a common interface for working with archive formats within node.
+
+[![NPM](https://nodei.co/npm/compress-commons.png)](https://nodei.co/npm/compress-commons/)
+
+## Install
+
+```bash
+npm install compress-commons --save
+```
+
+You can also use `npm install https://github.com/archiverjs/node-compress-commons/archive/master.tar.gz` to test upcoming versions.
+
+## Things of Interest
+
+- [Changelog](https://github.com/archiverjs/node-compress-commons/releases)
+- [Contributing](https://github.com/archiverjs/node-compress-commons/blob/master/CONTRIBUTING.md)
+- [MIT License](https://github.com/archiverjs/node-compress-commons/blob/master/LICENSE-MIT)
+
+## Credits
+
+Concept inspired by [Apache Commons Compress](http://commons.apache.org/proper/commons-compress/)™.
+
+Some logic derived from [Apache Commons Compress](http://commons.apache.org/proper/commons-compress/)™ and [OpenJDK 7](http://openjdk.java.net/). \ No newline at end of file