Skip to content

Commit 0e787b7

Browse files
authored
Merge pull request #63 from milwad-dev/add-md-documention
[1.x] Add md documentation
2 parents b2908df + 6c267d5 commit 0e787b7

File tree

4 files changed

+90
-0
lines changed

4 files changed

+90
-0
lines changed

docs/1.x/contributing.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Contributing
2+
This project exists thanks to all the people who contribute. [CONTRIBUTING](https://github.com/milwad-dev/laravel-validate/graphs/contributors)
3+
4+
<a href="https://github.com/milwad-dev/laravel-validate/graphs/contributors"><img src="https://opencollective.com/laravel-validate/contributors.svg?width=890&button=false" /></a>

docs/1.x/introduction.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Laravel Validate
2+
3+
<img src="https://banners.beyondco.de/Laravel%20Validate.png?theme=dark&packageManager=composer+require&packageName=milwad%2Flaravel-validate&pattern=circuitBoard&style=style_1&description=Help+to+write+easy+%26+faster+advance+validation+for+Laravel&md=1&showWatermark=1&fontSize=100px&images=https%3A%2F%2Flaravel.com%2Fimg%2Flogomark.min.svg" alt="laravel-validate-banner">
4+
5+
[![PHP Version Require](http://poser.pugx.org/milwad/laravel-validate/require/php)](https://packagist.org/packages/milwad/laravel-validate)
6+
[![Latest Stable Version](http://poser.pugx.org/milwad/laravel-validate/v)](https://packagist.org/packages/milwad/laravel-validate)
7+
[![Total Downloads](http://poser.pugx.org/milwad/laravel-validate/downloads)](https://packagist.org/packages/milwad/laravel-validate)
8+
[![License](http://poser.pugx.org/milwad/laravel-validate/license)](https://packagist.org/packages/milwad/laravel-validate)
9+
[![Passed Tests](https://github.com/milwad-dev/laravel-validate/actions/workflows/run-tests.yml/badge.svg)](https://github.com/milwad-dev/laravel-validate/actions/workflows/run-tests.yml)
10+
[![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)
11+
12+
***
13+
Laravel validate is a package for validate faster & easier. <br>
14+
You can validate data easier, Laravel validate have lots of rule class for validation. <br>
15+
This package support localization and you can use for most of the language. <br>
16+
(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/rules.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Rules
2+
3+
| # | Rule name | Usage |
4+
|----|----------------------------|--------------------------------------------------------------------------|
5+
| 1 | ValidBitcoinAddress | Validate bitcoin address for ex (1KFHE7w8BhaENAswwryaoccDb6qcT6DbYY) |
6+
| 2 | ValidCapitalCharWithNumber | Validate String for ex (MILWAD-84) |
7+
| 3 | ValidDiscordUsername | Validate username discord for ex (Milwad#2134) |
8+
| 4 | ValidHashtag | Validate hashtag for ex (#milwad) |
9+
| 5 | ValidIpAddressIPV4 | Validate ip address IPV4 for ex (129.144.50.56) |
10+
| 6 | ValidIpAddressIPV6 | Validate ip address IPV6 for ex (2001:db8:3333:4444:5555:6666:7777:8888) |
11+
| 7 | ValidPhoneNumber | Validate phone number for ex (09366000000) |
12+
| 8 | ValidPort | Validate port value for ex (8080) |
13+
| 9 | ValidSlug | Validate slug for ex (milwad-dev) |
14+
| 10 | ValidImei | Validate imei phone for ex (354809104295874) |
15+
| 11 | ValidStrongPassword | Validate password for ex (Milwad123!) |
16+
| 12 | ValidUrl | Validate url for ex (https://www.google.com) |
17+
| 13 | ValidUsername | Validate username for ex (milwad) |
18+
| 14 | ValidUuid | Validate uuid for ex (123e4567-e89b-12d3-a456-426655440000) |
19+
| 15 | ValidHexColor | Validate hex color for ex (#fcba03) |
20+
| 16 | ValidHtmlTag | Validate html tags for ex (``<h1></h1>``) |
21+
| 17 | ValidNationalCard | Validate national card for ex (015016437) |
22+
| 18 | ValidCarNumber | Validate car number for ex (KA01AB1234) |
23+
| 19 | ValidNameDaysWeek | Validate day week for ex (monday) |
24+
| 20 | ValidEvenNumber | Validate number is even for ex (1024) |
25+
| 21 | ValidOddNumber | Validate number is odd for ex (4321) |
26+
| 22 | ValidSlashEndOfString | Validate write slash at the string for ex (milwad/) |
27+
| 23 | ValidCartNumberIran | Validate cart number for ex (1234123412341234) |
28+
| 24 | ValidBase64 | Validate base64 for ex (bWlsd2Fk) |
29+
| 25 | ValidJwt | Validate jwt |
30+
| 26 | ValidJalaliDate | Validate jajali date for ex (1384/8/25) |
31+
| 27 | ValidDuplicateCharacter | Validate duplicate characters for ex (1,2,3,4,5,6,7,8,9) |
32+
| 28 | ValidPattern | Validate texts with specific pattern 🔥 for ex (4444-4444-4444) |
33+
| 29 | ValidDuplicate | Validate duplicate string, numbers for ex (1123456) |
34+
| 30 | ValidUlid | Validate ulid for ex (01ARZ3NDEKTSV4RRFFQ69G5FAV) |
35+
| 31 | ValidDomain | Validate domain name for ex (github.com) |
36+
| 32 | ValidCamelCase | Validate camel case for ex (milwadDev) |
37+
| 33 | ValidPascalCase | Validate pascal case for ex (MilwadDev) |
38+
| 34 | ValidKebabCase | Validate kebab case for ex (milwad-dev) |
39+
| 35 | ValidSnakeCase | Validate snake case for ex (milwad_dev) |
40+
| 36 | ValidVatId | Validate european VAT ID ex (EL123456789123) |
41+
| 37 | ValidIban | Validate IBAN ex (IR062960000000100324200001) |
42+
| 38 | ValidIranPostalCode | Validate Iran postal code ex (3354355599) |

docs/1.x/support-languages.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<a name="support-languages"></a>
2+
# Support Languages
3+
4+
If a language is not supported, you can make <a href="https://github.com/milwad-dev/laravel-validate/issues/new/choose">issue</a> to add it. <br>
5+
Also, you can make <a href="https://github.com/milwad-dev/laravel-validate/pulls">PR</a> to add it.
6+
7+
- [x] Arabic (ar)
8+
- [x] Azerbaijani (az)
9+
- [x] Catalan (ca)
10+
- [x] German (de)
11+
- [x] Greek (el)
12+
- [x] English (en)
13+
- [x] Spanish (es)
14+
- [x] Persian (fa)
15+
- [x] French (fr)
16+
- [x] Hindi (hi)
17+
- [x] Indonesian (id)
18+
- [x] Italian (It)
19+
- [x] Japanese (ja)
20+
- [x] Korean (ko)
21+
- [x] Kurdish Sorani (ku_so)
22+
- [x] Português Brasil (pt_BR)
23+
- [x] Russian (ru)
24+
- [x] Sinhala (si)
25+
- [x] Swedish (sv)
26+
- [x] Turkish (tr)
27+
- [x] Ukrainian (uk)
28+
- [x] Chinese (zh_CN)

0 commit comments

Comments
 (0)