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.md18
1 files changed, 10 insertions, 8 deletions
diff --git a/node_modules/browserify-zlib/README.md b/node_modules/browserify-zlib/README.md
index 61f323a3a..7cde70b50 100644
--- a/node_modules/browserify-zlib/README.md
+++ b/node_modules/browserify-zlib/README.md
@@ -1,21 +1,23 @@
# 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.
+[![Travis CI](https://travis-ci.org/devongovett/browserify-zlib.svg?branch=master)](https://travis-ci.org/devongovett/browserify-zlib)
+[![Dependency Status](https://david-dm.org/devongovett/browserify-zlib.svg?style=flat-square)](https://david-dm.org/devongovett/browserify-zlib) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
-[![browser support](https://ci.testling.com/devongovett/browserify-zlib.png)
-](https://ci.testling.com/devongovett/browserify-zlib)
+## Description
-[![node tests](https://travis-ci.org/devongovett/browserify-zlib.svg)
-](https://travis-ci.org/devongovett/browserify-zlib)
+Emulates Node's [zlib](https://nodejs.org/api/zlib.html) module for the browser. Can be used as a drop in replacement with [Browserify](http://browserify.org) and [webpack](http://webpack.github.io/).
+
+The heavy lifting is done using [pako](https://github.com/nodeca/pako). The code in this module is modeled closely after the code in the source of Node core to get as much compatability as possible.
+
+## API
+
+https://nodejs.org/api/zlib.html
## Not implemented
The following options/methods are not supported because pako does not support them yet.
* The `params` method
-* The `dictionary` option
## License