From 3552fedeb2f485b2cba8d04a4ef6262fd9dffd1c Mon Sep 17 00:00:00 2001 From: Rahul Chatterjee Date: Tue, 4 Apr 2017 09:56:39 -0400 Subject: Update README.md Cosmetic changes on the readme. And many thanks for porting `zxcvbn` to c/c++. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8403d8a..2f795ea 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