Skip to content

Commit 935a553

Browse files
committed
update README
1 parent cfc9dce commit 935a553

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ let string = str.generate(settings)
8080
8181
### Available options for all threee modes (**random, password, mask**)
8282
83-
| Name | Type | Description | Default Value | Allowed values |
83+
| Name | Type | Description | Default value | Allowed values |
8484
|------------|---------|--------------------------------------------|------------------------------|------------------------------|
8585
| amount | Integer | Amount of strings to generate | 1 | 0-Number.MAX_SAFE_INTEGER |
8686
| mode | String | Different modes to generate a string | 'random' | 'random', 'mask', 'password' |
@@ -91,7 +91,7 @@ let string = str.generate(settings)
9191
9292
### Available options for both **random and password** modes
9393
94-
| Name | Type | Description | Default Value | Allowed values |
94+
| Name | Type | Description | Default value | Allowed values |
9595
|-----------|---------|--------------------------------------------|---------------|---------------------------|
9696
| length | Integer | Size of the strings that will be generated | 8 | 0-Number.MAX_SAFE_INTEGER |
9797
| upperCase | Boolean | Determines whether it will be generated | true | true and false |
@@ -101,15 +101,15 @@ let string = str.generate(settings)
101101
102102
### Available options for **password** mode
103103
104-
| Name | Type | Description | Default Value | Allowed values |
104+
| Name | Type | Description | Default value | Allowed values |
105105
|-------------------|---------|----------------------------------------|---------------|---------------------------------------------------------|
106106
| showStrength | Boolean | Shows the password strength | false | true and false |
107107
| firstCharType | String | Determines the type of first character | 'random' | 'random', 'upperCase', 'lowerCase', 'special', 'number' |
108108
| excludeEqualChars | Boolean | Excludes characters that are equals | true | true and false |
109109
110110
### Available options for **mask** mode
111111
112-
| Name | Type | Description | Default Value | Allowed values |
112+
| Name | Type | Description | Default value | Allowed values |
113113
|---------------|--------|-----------------------------------------------|-----------------------|----------------|
114114
| mask | String | Mask to string that will be generated | '@#$%-@#$%-@#$%-@#$%' | * |
115115
| upperCaseMask | String | Letter that will be replaced a upperCase char | '@' | '*' |

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "generate-strings",
3-
"version": "1.1.0",
3+
"version": "1.1.1",
44
"description": "Generate random strings, strings with mask and strength passwords with password-strength tester",
55
"main": "generate-strings.js",
66
"scripts": {
@@ -20,7 +20,7 @@
2020
"front-end",
2121
"backend",
2222
"generate",
23-
"strings-manipulation"
23+
"string-manipulation"
2424
],
2525
"author": "Lucas Naja <lucasnaja0@gmail.com> (https://lucasnaja.github.io/portfolio)",
2626
"license": "MIT",

0 commit comments

Comments
 (0)