Skip to content

Commit

Permalink
Edited README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Robert committed Mar 16, 2023
1 parent ca1e39c commit d320d75
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Helga
![github stars](https://img.shields.io/github/stars/phrenotype/helga?style=social)
![packagist stars](https://img.shields.io/packagist/stars/chase/helga)
![packagist stars](https://img.shields.io/packagist/stars/helga/helga)
![license](https://img.shields.io/github/license/phrenotype/helga)
![contributors](https://img.shields.io/github/contributors/phrenotype/helga)
![contributors](https://img.shields.io/github/languages/code-size/phrenotype/helga)
![downloads](https://img.shields.io/packagist/dm/chase/helga)
![downloads](https://img.shields.io/packagist/dm/helga/helga)

This is a library for validation with easy customization of error messages. It validates everything from variables to files. It is not limited to form validation.

Expand All @@ -15,7 +15,7 @@ It has a clean free of unneccesary clutters.
Additionally, there are no external dependencies, apart from php, of course :).

## Install
`composer require chase/helga`
`composer require helga/helga`

## Usage

Expand All @@ -24,7 +24,7 @@ The most basic use is to validate single values.
```php
<?php

use Chase\Helga\validate;
use Helga\validate;

$v = validate("chase")->withRules(['required', 'minLen:5', 'maxLen:10']);

Expand All @@ -39,7 +39,7 @@ if($v->passes()){
```php
<?php

use Chase\Helga\validate;
use Helga\validate;

$v = validate("[email protected]")->withRules(['email']);

Expand All @@ -54,7 +54,7 @@ For multiple values, pass an associative array like so :
```php
<?php

use Chase\Helga\validate;
use Helga\validate;

$values = [
'name' => '',
Expand Down Expand Up @@ -96,7 +96,7 @@ By default, it only flattens and returns the first error for each field. Passing
```php
<?php

use Chase\Helga\validate;
use Helga\validate;

$values = [
'name' => 'ab1',
Expand Down Expand Up @@ -137,7 +137,7 @@ For directives without arguments i.e single directives
```php
<?php

use Chase\Helga\validate;
use Helga\validate;

$v = validate("c")->withRules([
'integer::It must be a number',
Expand All @@ -152,7 +152,7 @@ For directives with arguments
```php
<?php

use Chase\Helga\validate;
use Helga\validate;

$v = validate("c")->withRules([
'minLen:4:Cannot be less than four',
Expand All @@ -166,5 +166,5 @@ var_dump($v->errors());
**Email** : [email protected]

## In Summary...
Happy validation !!! :)
Happy validation :)

0 comments on commit d320d75

Please sign in to comment.