diff options
| author | tsyrogit <tsyrogit@users.noreply.github.com> | 2017-05-15 21:50:36 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-05-15 21:50:36 +0100 |
| commit | d0f75e0856e49fc23323b8c095e740dbd1deaf22 (patch) | |
| tree | 29e09c9fbe03b7d99d4ebe80d708d684d8926eb6 | |
| parent | e1eb658db2f04b9235a10d210a1ed551511bff78 (diff) | |
| parent | 3552fedeb2f485b2cba8d04a4ef6262fd9dffd1c (diff) | |
| download | zxcvbn-c-d0f75e0856e49fc23323b8c095e740dbd1deaf22.tar.gz | |
Merge pull request #12 from rchatterjee/patch-1
Update README.md
| -rw-r--r-- | README.md | 8 |
1 files changed, 4 insertions, 4 deletions
@@ -11,7 +11,7 @@ The original coffee script version is available at An article on the reasons for zxcvbn is at https://tech.dropox.com/2012/04/zxcvbn-realistic-password-strength-estimation -##Building +## Building The makefile will build several test programs to test the code. It shows the steps needed to use the code in C and C++ programs, using the dictionary data read from file or included @@ -32,7 +32,7 @@ Rename `zxcvbn.c` to `zxcvbn.cpp` (or whatever your compiler uses) to compile as The `dict*.h` and `zxcvbn.dict` files are generated by the dictgen program compiled from dict-generate.cpp (see makefile for details). -##Using +## Using Initially call `ZxcvbnInit()` with the pathname of the `zxcvbn.dict` file. This can be omitted when dictionary data is included in the executable. @@ -54,7 +54,7 @@ Review the test program in `test.c` for an example. The entropy calculated will sometimes differ from the original because of * The UK keyboard layout is also included, so there are additional spacial sequences, e.g. -**;'#** is a spacial sequence. +`;'#` is a spacial sequence. * The different character classes in a password are taken into account when calculating the strength of brute-force matches. * Dijktra's path searching algorithm is used to combine parts of the entered password. This @@ -73,7 +73,7 @@ version when there are 4 or less parts, but will differ significantly when there parts (which is likely to be a rare occurrence). -##References +## References The original coffee-script version is available at https://github.com/lowe/zxcvbn |