aboutsummaryrefslogtreecommitdiffstats
path: root/node_modules/express/node_modules/crc/README.md
blob: 26ce22fdf44a4b9788dada5e38e8038a4c37bb02 (plain) (blame)
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
# JavaScript CRC 8, 16 and 32.

This is a basic port/copy of the JavaScript CRC implementation. The module works with any CommonJS system supporting `module.exports` notation as well as in the browser. When loaded in the browser, all functions end up under the `window.crc` "namespace".

Original code is taken from http://www.digsys.se/JavaScript/CRC.aspx 

## Functions

The following functions are implemented:

    crc8(String)	#=> Number
    crcArc(String)	#=> Number
    crc16(String)	#=> Number
    fcs16(String)	#=> Number
    crc32(String)	#=> Number
    hex8(Number)	#=> String
    hex16(Number)	#=> String
    hex32(Number)	#=> String

## Installation

	git clone git://github.com/alexgorbatchev/node-crc.git

or

    npm install crc

## Running tests

    $ npm install
    $ make test