From 50b74db43bc3467b3fbf28b10606e955b40566ed Mon Sep 17 00:00:00 2001 From: tony Date: Sun, 18 Jun 2017 17:40:55 +0100 Subject: Revert commit 3552fedeb2f485b2cba8d04a4ef6262fd9dffd1c. This has been done to clarify the licensing of past contributions. There has not any response from rchatterjee regarding this so reverting his updates(see conversation for github pull request #12). Other contributors have accepted the change (see github pull requests #11, #14 and github issue #15). --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ae61491..73cd924 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3