Skip to content

Commit dd11379

Browse files
committed
docs: update README
1 parent 4ac79d8 commit dd11379

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,36 @@ const PasswordToolKit = require('password-toolkit');
5454
// Create an instance of PasswordToolKit
5555
const passwordToolKit = new PasswordToolKit();
5656

57+
// It is equivalent
58+
const passwordToolKit = new PasswordToolKit({
59+
maximum: 30,
60+
suggestions: [
61+
'The password must have at least 8 characters.',
62+
'Add uppercase and lowercase letters to make the password more secure.',
63+
'Add numbers to make the password more secure.',
64+
'Add symbols to make the password more secure.',
65+
'Avoid using repeated characters in the password.',
66+
'Avoid using common password patterns.',
67+
'Excellent! The password is secure.',
68+
],
69+
qualities: ['insecure', 'low', 'medium', 'high', 'perfect'],
70+
});
71+
72+
// Or You can translate the messages for the evaluation of the password
73+
const passwordToolKit = new PasswordToolKit({
74+
maximum: 30,
75+
suggestions: [
76+
'La contraseña debe tener al menos 8 caracteres.',
77+
'Agregue letras mayúsculas y minúsculas para que la contraseña sea más segura.',
78+
'Agregue números para que la contraseña sea más segura.',
79+
'Agregue símbolos para que la contraseña sea más segura.',
80+
'Evitar el uso de caracteres repetidos en la contraseña.',
81+
'Evitar el uso de patrones de contraseña comunes.',
82+
'¡Excelente! La contraseña es segura.',
83+
],
84+
qualities: ['Inseguro', 'Bajo', 'Medio', 'Alto', 'Perfecto'],
85+
});
86+
5787
// Generate a password
5888
const options = {
5989
size: 12,

0 commit comments

Comments
 (0)