Skip to content

Commit 4b60b49

Browse files
committed
Improvements to readme and composer content
1 parent 5c763ca commit 4b60b49

File tree

2 files changed

+17
-7
lines changed

2 files changed

+17
-7
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Laravel Validator Rules - Offensive
22

3-
This rule will validate that a field isn't offensive.
4-
3+
This rule will validate that a field isn't offensive. It can be useful to check user supplied data that may be publicly displayed, such as usernames or comments.
54

65
## Installation
76

@@ -12,12 +11,23 @@ composer require laravel-validation-rules/offensive
1211

1312
## Usage
1413

14+
```php
15+
use DivineOmega\LaravelOffensiveValidationRule\Offensive;
16+
17+
$request->validate([
18+
'username' => ['required', new Offensive],
19+
]);
20+
```
1521

16-
### License
17-
This project is licensed under an Apache 2.0 license which you can find
18-
[in this LICENSE](https://github.com/laravel-validation-rules/offensive/blob/master/LICENSE).
22+
## License
23+
This project is licensed under a GNU Lesser General Public License v3.0 which you can find
24+
[in this LICENSE](https://github.com/laravel-validation-rules/exposed-password/blob/master/LICENSE).
1925

2026

21-
### Feedback
27+
## Feedback
2228
If you have any feedback, comments or suggestions, please feel free to open an
2329
issue within this repository.
30+
31+
## Laravel Validation Rules
32+
33+
This package is part of the Laravel Validation Rules collection. If you're after more useful validation rules, head to the [Laravel Validation Rules](https://laravel-validation-rules.github.io/) website.

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "laravel-validation-rules/offensive",
3-
"version": "1.0.0",
3+
"description": "Metapackage for https://github.com/DivineOmega/laravel-offensive-validation-rule",
44
"type": "metapackage",
55
"require": {
66
"divineomega/laravel-offensive-validation-rule": "1.0.0"

0 commit comments

Comments
 (0)