mirror of
https://github.com/sigmasternchen/jsPasswordChecker
synced 2025-03-16 08:18:55 +00:00
Update README.md
This commit is contained in:
parent
8cabeb55dc
commit
c76902890b
1 changed files with 27 additions and 1 deletions
28
README.md
28
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
|
||||
|
|
Loading…
Reference in a new issue