summaryrefslogtreecommitdiff
path: root/node_modules/sumchecker/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/sumchecker/README.md')
-rw-r--r--node_modules/sumchecker/README.md80
1 files changed, 0 insertions, 80 deletions
diff --git a/node_modules/sumchecker/README.md b/node_modules/sumchecker/README.md
deleted file mode 100644
index 8c927b7..0000000
--- a/node_modules/sumchecker/README.md
+++ /dev/null
@@ -1,80 +0,0 @@
-# Sumchecker
-
-[![Travis CI](https://travis-ci.org/malept/sumchecker.svg?branch=master)](https://travis-ci.org/malept/sumchecker)
-[![AppVeyor CI](https://ci.appveyor.com/api/projects/status/wm4n2r11nlff8ify?svg=true)](https://ci.appveyor.com/project/malept/sumchecker)
-[![Code Climate](https://codeclimate.com/github/malept/sumchecker/badges/gpa.svg)](https://codeclimate.com/github/malept/sumchecker)
-[![Test Coverage](https://codeclimate.com/github/malept/sumchecker/badges/coverage.svg)](https://codeclimate.com/github/malept/sumchecker/coverage)
-
-Sumchecker is a pure Node.js solution to validating files specified in a checksum file, which are
-usually generated by programs such as [`sha256sum`](https://en.wikipedia.org/wiki/Sha256sum).
-
-## Usage
-
-```javascript
-sumchecker(algorithm, checksumFilename, baseDir, filesToCheck)
- .then(() => {
- console.log('All files validate!');
- }, (error) => {
- console.error('An error occurred', error);
- });
-```
-
-Returns a [`Promise`](https://www.promisejs.org/). The promise is resolved when all files specified
-in [`filesToCheck`](#filesToCheck) are validated. The promise is rejected otherwise.
-
-### Parameters
-
-#### `algorithm`
-
-`String` - The hash algorithm used in [`checksumFilename`](#checksumFilename). Corresponds to the
-algorithms allowed by [`crypto.createHash()`].
-
-#### `checksumFilename`
-
-`String` - The path to the checksum file.
-
-#### `baseDir`
-
-`String` - The base directory for the files specified in [`filesToCheck`](#filesToCheck).
-
-#### `filesToCheck`
-
-`Array` or `String` - one or more paths of the files that will be validated, relative to
-[`baseDir`](#baseDir).
-
-### Errors
-
-These are `sumchecker`-specific error classes that are passed to the promise's reject callback.
-
-#### `sumchecker.ChecksumMismatchError`
-
-When at least one of the files does not match its expected checksum.
-
-Properties:
-
-* `filename` (`String`) - a path to a file that did not match
-
-#### `sumchecker.ChecksumParseError`
-
-When the checksum file cannot be parsed (as in, it does not match the checksum file format).
-
-Properties:
-
-* `lineNumber` (`Number`) - the line number that could not be parsed
-* `line` (`String`) - the raw line data that could not be parsed, sans newline
-
-#### `sumchecker.NoChecksumFoundError`
-
-When at least one of the files specified to check is not listed in the checksum file.
-
-Properties:
-
-* `filename` (`String`)- a filename from [`filesToCheck`](#filesToCheck)
-
-## Legal
-
-This library is copyrighted under the terms of the [Apache 2.0 License].
-
-[`crypto.createHash()`]: https://nodejs.org/dist/latest-v4.x/docs/api/crypto.html#crypto_crypto_createhash_algorithm
-[`Promise.all`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/all
-[Apache 2.0 License]: http://www.apache.org/licenses/LICENSE-2.0