Browse files

clarify purpose of this module

  • Loading branch information...
1 parent 523477f commit 7dea5b1b98827b34ed67c794ddb044651ab780e8 @kkaefer committed Mar 11, 2011
Showing with 2 additions and 0 deletions.
  1. +2 −0 README.md
View
2 README.md
@@ -15,6 +15,8 @@ Install with `npm install zlib`.
var compressed = zlib.deflate(input);
var output = zlib.inflate(compressed);
+Note that `node-zlib` is only intended for small (< 128 KB) data that you already have buffered. It is not meant for input/output streams.
+
# BUILDING
Make sure you have `zlib` installed. Mac OS X ships with it by default.

0 comments on commit 7dea5b1

Please sign in to comment.