coffeenode-zxcvbn/README.md

realistic password strength estimation

# CoffeeNode ZXCVBN


Derived from [node-zxcvbn](https://github.com/mintplant/node-zxcvbn), which itself is [zxcvbn](https://github.com/lowe/zxcvbn),
a password strength calculator, packaged as a node.js module. Authored by Dan Wheeler at Dropbox; published
to npm by Michael Smith.

See [the original](https://github.com/lowe/zxcvbn) for more details.

This module has the distinction to include all files resulting from various build steps that are not terribly
obvious even from the original README. The JS code that you get with `require( 'coffeenode-zxcvbn' )` is
optimized using the ClosureJS compiler, resulting in a filesize of roughly 700MB.

# How to use

In CoffeeScript:

```coffeescript
zxcvbn = require 'coffeenode-zxcvbn'
report = zxcvbn password
```

`report` is a Plain Old Dictionary; the interesting attributes are `report[ 'crack_time_display' ]`,
`report[ 'crack_time' ]`, `report[ 'score' ]`, and `report[ 'entropy' ]`; please refer to the original documentation
linked above.


<!--

# result.entropy            # bits

# result.crack_time         # estimation of actual crack time, in seconds.

# result.crack_time_display # same crack time, as a friendlier string:
#                           # "instant", "6 minutes", "centuries", etc.

# result.score              # [0,1,2,3,4] if crack time is less than
#                           # [10**2, 10**4, 10**6, 10**8, Infinity].
#                           # (useful for implementing a strength bar.)

# result.match_sequence     # the list of patterns that zxcvbn based the
#                           # entropy calculation on.

# result.calculation_time   # how long it took to calculate an answer,
#                           # in milliseconds. usually only a few ms.
 -->