aboutsummaryrefslogtreecommitdiff
path: root/node_modules/browserify-zlib/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/browserify-zlib/README.md')
-rw-r--r--node_modules/browserify-zlib/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/node_modules/browserify-zlib/README.md b/node_modules/browserify-zlib/README.md
new file mode 100644
index 000000000..61f323a3a
--- /dev/null
+++ b/node_modules/browserify-zlib/README.md
@@ -0,0 +1,22 @@
+# browserify-zlib
+
+Emulates Node's [zlib](http://nodejs.org/api/zlib.html) module for [Browserify](http://browserify.org)
+using [pako](https://github.com/nodeca/pako). It uses the actual Node source code and passes the Node zlib tests
+by emulating the C++ binding that actually calls zlib.
+
+[![browser support](https://ci.testling.com/devongovett/browserify-zlib.png)
+](https://ci.testling.com/devongovett/browserify-zlib)
+
+[![node tests](https://travis-ci.org/devongovett/browserify-zlib.svg)
+](https://travis-ci.org/devongovett/browserify-zlib)
+
+## Not implemented
+
+The following options/methods are not supported because pako does not support them yet.
+
+* The `params` method
+* The `dictionary` option
+
+## License
+
+MIT