/usr/share/doc/node-zlib/README.md is in node-zlib 1.0.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | # NAME
node-zlib - Simple, synchronous deflate/inflate for node.js buffers.
# USAGE
Install with `npm install zlib`.
var Buffer = require('buffer').Buffer;
var zlib = require('zlib');
var input = new Buffer('lorem ipsum dolor sit amet');
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.
To obtain and build the bindings:
git clone git://github.com/kkaefer/node-zlib.git
cd node-zlib
./configure
make
You can also use [`npm`](https://github.com/isaacs/npm) to download and install them:
npm install zlib
# TESTS
[expresso](https://github.com/visionmedia/expresso) is required to run unit tests.
npm install expresso
make test
# CONTRIBUTORS
* [Konstantin Käfer](https://github.com/kkaefer)
# LICENSE
`node-zlib` is [BSD licensed](https://github.com/kkaefer/node-zlib/raw/master/LICENSE).
|