version 1.0.0 prepared

Author: AbmSourav

.gitignore

@@ -7,6 +7,10 @@ yarn-error.log*
 lerna-debug.log*
 .pnpm-debug.log*
 
+.DS_Store
+
+vendor/
+
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 

README.md

@@ -1,9 +1,15 @@
-# validator
+# Validator
 
 Data validation composer package.
 
 ## Installation
 
+Install using composer.
+
+```
+composer require codesvault/validator
+```
+
 <br>
 <br>
 
@@ -14,6 +20,8 @@ $validator = Validator::validate(
     [
         'username'	=> 'required|stringOnly',
         'full_name'	=> 'stringWithSpace',
+		'password'	=> 'required|min:8',
+		'email'		=> 'required|email',
     ],
 );
 ```
@@ -36,13 +44,38 @@ $validator = Validator::validate(
 ```
 
 <br>
+<br>
+
+## Handling Errors
 
-`validate` method will return an object of `ValidationEngine` class.
+If any data is invalid then `error` method will return error messages array. Otherwise it'll return false.
+<br>
+`getData` method will return validated data array.
 
 ```php
-if ($validator->error()) {
-	return $validator->getErrorList();
+$error = $validator->error();
+if ($error) {
+	return $error;
 }
-
-return $validator->getData();
+$validator->getData();
 ```
+
+<br>
+<br>
+
+## Available Rules
+
+| Rule | Description |
+| --- | --- |
+| required | Check if the field under validation is present in the input data and is not empty. |
+| email | Check if the field under validation is valid email address. |
+| url | Check if the field under validation is valid url. |
+| string | Check if the field under validation is string. |
+| stringOnly | Check if the field under validation is only string charecters. |
+| stringWithSpace | Check if the field under validation is string with space. |
+| stringWithNumber | Check if the field under validation is string with number. |
+| StringWithDash | Check if the field under validation is string with dash and underscore. |
+| min | Check if the field under validation is greater than or equal to the given value. |
+| max | Check if the field under validation is less than or equal to the given value. |
+| integer | Check if the field under validation is integer. |
+| sameValue | Check if the field under validation is same as the given value. |

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "codesvault/validator",
-    "description": "data validator package",
-    "version": "0.0.1",
+    "description": "Data validator library",
+    "version": "1.0.0",
     "type": "library",
     "license": "MIT",
     "autoload": {