Merge pull request #64 from milwad-dev/add-md-documention

[1.x] Add all documentation

Author: milwad-dev

docs/1.x/rules.md renamed to docs/1.x/all-rules.md

@@ -1,4 +1,4 @@
-                                                       # Requirements
+# Requirements
 ***
 - ```PHP >= 8.0```
 - ```Laravel >= 9.0```
@@ -12,20 +12,20 @@
 | 1.7       | :x:                | :x:                | :x:                | :white_check_mark: | :white_check_mark: |
 
 # Installation
-You can install package with composer.
+You can install the package with Composer.
 
 ```bash
 composer require milwad/laravel-validate
 ```
 
 # Publish
-If you want to publish lang file for custom validation message you can run this command in terminal:
+If you want to publish a lang file for a custom validation message you can run this command in the terminal:
 
 ```shell
 php artisan vendor:publish --tag="validate-lang-{$lang}"
 ```
 
-You can replace `$lang` to your lang name, for ex:
+You can replace `$lang` with your lang name, for ex:
 
 ```shell
 php artisan vendor:publish --tag="validate-lang-en"

docs/1.x/installation.md

@@ -10,7 +10,7 @@
 [![Quality Score](https://img.shields.io/scrutinizer/g/milwad-dev/laravel-validate.svg?style=flat-square)](https://scrutinizer-ci.com/g/milwad-dev/laravel-validate)
 
 ***
-Laravel validate is a package for validate faster & easier. <br>
+Laravel validate is a package for validation faster & easier. <br>
 You can validate data easier, Laravel validate have lots of rule class for validation. <br>
-This package support localization and you can use for most of the language. <br>
+This package support localization and you can use it for most of the language. <br>
 (If some language didn't support, you can <a href="https://github.com/milwad-dev/laravel-validate/pulls">PR</a> for new language)

docs/1.x/introduction.md

@@ -0,0 +1,11 @@
+## ValidBase64
+
+If you want to validate base64, you can use `ValidBase64` rule:
+
+```php
+use Milwad\LaravelValidate\Rules\ValidBase64;
+
+return [
+    'base64' => ['required', new ValidBase64()], // base64 => bWlsd2Fk
+];
+```

docs/1.x/valid-base64.md

@@ -0,0 +1,11 @@
+## ValidBitcoinAddress
+
+If you want to validate your Bitcoin address you can use the `ValidBitcoinAddress` rule: 
+
+```php
+use Milwad\LaravelValidate\Rules\ValidBitcoinAddress;
+
+return [
+    'bitcoin-address' => ['required', new ValidBitcoinAddress()], // bitcoin-address => 1KFHE7w8BhaENAswwryaoccDb6qcT6DbYY
+];
+```

docs/1.x/valid-bitcoin-address.md

@@ -0,0 +1,11 @@
+## ValidCamelCase
+
+If you want to validate the camel-case string, you can use the `ValidCamelCase` rule:
+
+```php
+use Milwad\LaravelValidate\Rules\ValidCamelCase;
+
+return [
+    'camel-case' => ['required', new ValidCamelCase()], // camel-case => milwadDev
+];
+```

docs/1.x/valid-camel-case.md

@@ -0,0 +1,11 @@
+## ValidCapitalCharWithNumber
+
+If you want to validate a capital character with the number you can use the `ValidCapitalCharWithNumber` rule:
+
+```php
+use Milwad\LaravelValidate\Rules\ValidCapitalCharWithNumber;
+
+return [
+    'capital-char-number' => ['required', new ValidCapitalCharWithNumber()], // capital-char-with-number => MILWAD-84
+];
+```

docs/1.x/valid-capital-char-with-number.md

@@ -0,0 +1,11 @@
+## ValidCarNumber
+
+If you want to validate the car number, you can use the `ValidCarNumber` rule:
+
+```php
+use Milwad\LaravelValidate\Rules\ValidCarNumber;
+
+return [
+    'car-number' => ['required', new ValidCarNumber()], // car-number => KA01AB1234
+];
+```

docs/1.x/valid-car-number.md

@@ -0,0 +1,11 @@
+## ValidCartNumberIran
+
+If you want to validate the cart Iran number, you can use the `ValidCartNumberIran` rule:
+
+```php
+use Milwad\LaravelValidate\Rules\ValidCartNumberIran;
+
+return [
+    'number' => ['required', new ValidCartNumberIran()], // number => 1234123412341234
+];
+```

docs/1.x/valid-cart-number-iran.md

@@ -0,0 +1,11 @@
+## ValidDiscordUsername
+
+If you want to validate the discord username, you can use the `ValidDiscordUsername` rule: 
+
+```php
+use Milwad\LaravelValidate\Rules\ValidDiscordUsername;
+
+return [
+    'discord-username' => ['required', new ValidDiscordUsername()], // discord-username => Milwad#2134
+];
+```