Skip to content
This repository was archived by the owner on Mar 13, 2025. It is now read-only.

Commit 96827fa

Browse files
committed
chore: added base README
1 parent ebc49a3 commit 96827fa

File tree

1 file changed

+46
-1
lines changed

1 file changed

+46
-1
lines changed

README.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,46 @@
1-
# yet-another-php-validator
1+
# Yet Another PHP Validator
2+
3+
Focused on validating development code with expressive error messages.
4+
5+
## Requirements
6+
7+
- PHP 8.1 or higher.
8+
9+
## Installation
10+
11+
You can install the library via [Composer](https://getcomposer.org/):
12+
13+
```bash
14+
composer require programmatordev/yet-another-php-validator
15+
```
16+
17+
To use the library, use Composer's [autoload](https://getcomposer.org/doc/01-basic-usage.md#autoloading):
18+
19+
```php
20+
require_once 'vendor/autoload.php';
21+
```
22+
23+
## Basic Usage
24+
25+
Simple usage looks like:
26+
27+
```php
28+
29+
```
30+
31+
## Documentation
32+
33+
34+
## Contributing
35+
36+
Any form of contribution to improve this library will be welcome and appreciated.
37+
Make sure to open a pull request or issue.
38+
39+
## Acknowledgments
40+
41+
This library is inspired by [Respect's Validation](https://github.com/Respect/Validation) and [Symfony's Validator](https://symfony.com/doc/current/validation.html).
42+
43+
## License
44+
45+
This project is licensed under the MIT license.
46+
Please see the [LICENSE](LICENSE) file distributed with this source code for further information regarding copyright and licensing.

0 commit comments

Comments
 (0)