From c76902890b062528018f9825885a6a5140d80580 Mon Sep 17 00:00:00 2001 From: overflowerror Date: Sat, 5 Aug 2017 21:55:17 +0200 Subject: [PATCH] Update README.md --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9c0cef8..7051936 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ # jsPasswordChecker -Check Passwords for certain criteria +This is a little tool I wrote for a friend of mine to determine if certain password criteria are met. + +## How to Use + +Just include the file (jsPasswordChecker.js) to your project and then: +```javascript +var checker = new PasswordChecker({ + // add criteria here +}); +checker.check(password); +``` + +Simple as that. + +## Criteria Object + +In the current version the following criteria can be set: + +- minLength +- maxLength +- containsNumbers +- containsLowerCaseCharacters +- containsUpperCaseCharacters +- containsWhiteSpaces +- containsSpecialCharacters +- dictionary +- maxCharacterRepetition