Update README and documentation

README.md

@@ -11,6 +11,7 @@ Detects:
  - Passwords from a dictionary / wordlist: `ErrDictionary`
  - Mangled / reversed passwords, like "p@ssw0rd" or "drowssap": `ErrMangledDictionary`
  - Hashed dictionary words, like "5f4dcc3b5aa765d61d8327deb882cf99" (the md5sum of "password"): `ErrHashedDictionary`
+ - Optional hash checks against the haveibeenpwned.com database: `ErrFoundHIBP`
 
 Your system dictionaries from `/usr/share/dict` will be indexed. If no dictionaries were found, crunchy only relies on
 the regular sanity checks (`ErrEmpty`, `ErrTooShort`, `ErrTooFewChars` and `ErrTooSystematic`). On Ubuntu it is

errors.go

@@ -47,6 +47,6 @@ var (
 	ErrMangledDictionary = errors.New("Password is mangled, but too common / from a dictionary")
 	// ErrHashedDictionary gets returned when the password is hashed, but found in a dictionary
 	ErrHashedDictionary = errors.New("Password is hashed, but too common / from a dictionary")
-	// ErrFoundInPwned gets returned when the password has been found on https://haveibeenpwned.com
+	// ErrFoundHIBP gets returned when the password has been found on https://haveibeenpwned.com
 	ErrFoundHIBP = errors.New("Password has been found inside haveibeenpwned.com database")
 )

hibp.go

@@ -35,5 +35,4 @@ func foundInHIBP(s string) error {
 	}
 
 	return nil
-
 }