Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasgdb committed Jan 4, 2019
1 parent cfc9dce commit 935a553
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ let string = str.generate(settings)
### Available options for all threee modes (**random, password, mask**)
| Name | Type | Description | Default Value | Allowed values |
| Name | Type | Description | Default value | Allowed values |
|------------|---------|--------------------------------------------|------------------------------|------------------------------|
| amount | Integer | Amount of strings to generate | 1 | 0-Number.MAX_SAFE_INTEGER |
| mode | String | Different modes to generate a string | 'random' | 'random', 'mask', 'password' |
Expand All @@ -91,7 +91,7 @@ let string = str.generate(settings)
### Available options for both **random and password** modes
| Name | Type | Description | Default Value | Allowed values |
| Name | Type | Description | Default value | Allowed values |
|-----------|---------|--------------------------------------------|---------------|---------------------------|
| length | Integer | Size of the strings that will be generated | 8 | 0-Number.MAX_SAFE_INTEGER |
| upperCase | Boolean | Determines whether it will be generated | true | true and false |
Expand All @@ -101,15 +101,15 @@ let string = str.generate(settings)
### Available options for **password** mode
| Name | Type | Description | Default Value | Allowed values |
| Name | Type | Description | Default value | Allowed values |
|-------------------|---------|----------------------------------------|---------------|---------------------------------------------------------|
| showStrength | Boolean | Shows the password strength | false | true and false |
| firstCharType | String | Determines the type of first character | 'random' | 'random', 'upperCase', 'lowerCase', 'special', 'number' |
| excludeEqualChars | Boolean | Excludes characters that are equals | true | true and false |
### Available options for **mask** mode
| Name | Type | Description | Default Value | Allowed values |
| Name | Type | Description | Default value | Allowed values |
|---------------|--------|-----------------------------------------------|-----------------------|----------------|
| mask | String | Mask to string that will be generated | '@#$%-@#$%-@#$%-@#$%' | * |
| upperCaseMask | String | Letter that will be replaced a upperCase char | '@' | '*' |
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "generate-strings",
"version": "1.1.0",
"version": "1.1.1",
"description": "Generate random strings, strings with mask and strength passwords with password-strength tester",
"main": "generate-strings.js",
"scripts": {
Expand All @@ -20,7 +20,7 @@
"front-end",
"backend",
"generate",
"strings-manipulation"
"string-manipulation"
],
"author": "Lucas Naja <[email protected]> (https://lucasnaja.github.io/portfolio)",
"license": "MIT",
Expand Down

0 comments on commit 935a553

Please sign in to comment.