[Pkg-javascript-commits] [node-browserify-zlib] 02/33: Update docs

[Bastien Roucariès]

This is an automated email from the git hooks/post-receive script.

rouca pushed a commit to branch master
in repository node-browserify-zlib.

commit effbabbd7a2a100d84f22c45e07e154faed05ad3
Author: Devon Govett <devongovett at gmail.com>
Date:   Mon Apr 7 22:55:53 2014 -0700

    Update docs
---
 README.md      | 7 +++++++
 src/binding.js | 3 +++
 2 files changed, 10 insertions(+)

diff --git a/README.md b/README.md
index ca50b47..f82e3cc 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,13 @@ Emulates Node's [zlib](http://nodejs.org/api/zlib.html) module for [Browserify](
 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.
 
+## Not implemented
+
+The following options/methods are not supported because pako does not support them yet.
+
+* The `params` method
+* The `dictionary` option
+
 ## License
 
 MIT
diff --git a/src/binding.js b/src/binding.js
index 230ea5b..8b706bd 100644
--- a/src/binding.js
+++ b/src/binding.js
@@ -18,6 +18,9 @@ exports.DEFLATERAW = 5;
 exports.INFLATERAW = 6;
 exports.UNZIP = 7;
 
+/**
+ * Emulate Node's zlib C++ layer for use by the JS layer in index.js
+ */
 function Zlib(mode) {
   if (mode < exports.DEFLATE || mode > exports.UNZIP)
     throw new TypeError("Bad argument");

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-browserify-zlib.git