aboutsummaryrefslogtreecommitdiff
path: root/node_modules/crc32-stream/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/crc32-stream/README.md')
-rw-r--r--node_modules/crc32-stream/README.md79
1 files changed, 0 insertions, 79 deletions
diff --git a/node_modules/crc32-stream/README.md b/node_modules/crc32-stream/README.md
deleted file mode 100644
index a0b508054..000000000
--- a/node_modules/crc32-stream/README.md
+++ /dev/null
@@ -1,79 +0,0 @@
-# crc32-stream v2.0.0 [![Build Status](https://travis-ci.org/archiverjs/node-crc32-stream.svg?branch=master)](https://travis-ci.org/archiverjs/node-crc32-stream) [![Build status](https://ci.appveyor.com/api/projects/status/sy60s39cmyvd60i3/branch/master?svg=true)](https://ci.appveyor.com/project/ctalkington/node-crc32-stream/branch/master)
-
-crc32-stream is a streaming CRC32 checksumer. It uses [buffer-crc32](https://www.npmjs.org/package/buffer-crc32) behind the scenes to reliably handle binary data and fancy character sets. Data is passed through untouched.
-
-### Install
-
-```bash
-npm install crc32-stream --save
-```
-
-You can also use `npm install https://github.com/archiverjs/node-crc32-stream/archive/master.tar.gz` to test upcoming versions.
-
-### Usage
-
-#### CRC32Stream
-
-Inherits [Transform Stream](http://nodejs.org/api/stream.html#stream_class_stream_transform) options and methods.
-
-```js
-var CRC32Stream = require('crc32-stream');
-
-var source = fs.createReadStream('file.txt');
-var checksum = new CRC32Stream();
-
-checksum.on('end', function(err) {
- // do something with checksum.digest() here
-});
-
-// either pipe it
-source.pipe(checksum);
-
-// or write it
-checksum.write('string');
-checksum.end();
-```
-
-#### DeflateCRC32Stream
-
-Inherits [zlib.DeflateRaw](http://nodejs.org/api/zlib.html#zlib_class_zlib_deflateraw) options and methods.
-
-```js
-var DeflateCRC32Stream = require('crc32-stream').DeflateCRC32Stream;
-
-var source = fs.createReadStream('file.txt');
-var checksum = new DeflateCRC32Stream();
-
-checksum.on('end', function(err) {
- // do something with checksum.digest() here
-});
-
-// either pipe it
-source.pipe(checksum);
-
-// or write it
-checksum.write('string');
-checksum.end();
-```
-
-### Instance API
-
-#### digest()
-
-Returns the checksum digest in unsigned form.
-
-#### hex()
-
-Returns the hexadecimal representation of the checksum digest. (ie E81722F0)
-
-#### size(compressed)
-
-Returns the raw size/length of passed-through data.
-
-If `compressed` is `true`, it returns compressed length instead. (DeflateCRC32Stream)
-
-## Things of Interest
-
-- [Changelog](https://github.com/archiverjs/node-crc32-stream/releases)
-- [Contributing](https://github.com/archiverjs/node-crc32-stream/blob/master/CONTRIBUTING.md)
-- [MIT License](https://github.com/archiverjs/node-crc32-stream/blob/master/LICENSE-MIT) \ No newline at end of file