Skip to content

Commit 000c85e

Browse files
committed
Improve readme
1 parent d046afd commit 000c85e

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
1-
# laravel-password-exposed-validation-rule
2-
🔒 Laravel validation rule that checks if a password has been exposed in a data breach
1+
# 🔒 Laravel Password Exposed Validation Rule
2+
3+
This package provides a Laravel validation rule that checks if a password has been exposed in a data breach.
4+
It should work on Laravel 5.1 and above.
5+
6+
## Installation
7+
8+
To install, just run the following Composer command.
9+
10+
```
11+
composer require divineomega/laravel-password-exposed-validation-rule
12+
```
13+
14+
## Usage
15+
16+
The following code snippet shows an example of how to use the password exposed validation rule.
17+
18+
```php
19+
use DivineOmega\LaravelPasswordExposedValidationRule\PasswordExposed;
20+
21+
$request->validate([
22+
'password' => ['required', new PasswordExposed],
23+
]);
24+
```

0 commit comments

Comments
 (0)