Skip to content

Commit edae283

Browse files
authored
README formatting
1 parent dad4560 commit edae283

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
11
# Password Checker
22

3-
A Deno module to test if a password/string matches the preset criteria.
3+
A Deno🦕 module to test if a password/string matches the preset criteria.
44

55
## Installation
66

7-
`import { checkPassword } from "https://deno.land/x/password-checker/mods.ts";`
7+
```typescript
8+
import { checkPassword } from "https://deno.land/x/password-checker/mods.ts";
9+
```
810

911
## Parameters
1012

1113
### Mandatory Parameters:
1214

13-
- password: string
15+
- `password: string`
1416

1517
### Optional Parameters:
1618

17-
- minLen: number - To check the password against a minimum length. Defaults to 0
19+
- `minLen: number` - To check the password against a minimum length. Defaults to 0
1820
which disables the check.
19-
- maxLen: number - To check the password against a maximum length. Defaults to 0
21+
- `maxLen: number` - To check the password against a maximum length. Defaults to 0
2022
which disables the check.
21-
- containsNum: boolean - To check if the password contains any numbers. Defaults
23+
- `containsNum: boolean` - To check if the password contains any numbers. Defaults
2224
to true and enables the check.
23-
- containsSpecialChar: boolean - To check if the password contains any special
25+
- `containsSpecialChar: boolean` - To check if the password contains any special
2426
characters. Defaults to true and enables the check.
25-
- containsAlphabet: boolean - To check if the password contains any alphabets.
27+
- `containsAlphabet: boolean` - To check if the password contains any alphabets.
2628
Defaults to true and enables the check.
2729

2830
## Usage

0 commit comments

Comments
 (0)