Skip to content

Commit e84e807

Browse files
committed
Updated Docs
1 parent 829bb54 commit e84e807

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ $isValidUrl = EloquentRegex::source($link)->url()->check(); // true
6464
**Another:**
6565

6666
```php
67-
$isStrong = EloquentRegex::source("StrongP@ssw0rd")->password(function($string) {
68-
return $string->minLength(8)->minUppercase(1)->minNumbers(1)->minSpecialChars(1);
67+
$isStrong = EloquentRegex::source("StrongP@ssw0rd")->password(function($options) {
68+
$options->minLength(8)->minUppercase(1)->minNumbers(1)->minSpecialChars(1);
6969
})->check(); // true
7070
```
7171

@@ -87,14 +87,12 @@ _For more details about package and it's inner workings check out [STRUCTURE.md]
8787

8888
## Getting Started
8989

90-
Simply install the package via Composer, and you're ready to take the pain out of regex in your PHP/Laravel applications. Follow our quick start guide below to dive in.
90+
Simply install the package via Composer, and you're ready to take the pain out of regex in your PHP/Laravel applications. Run for installation:
9191

9292
```bash
9393
composer require maestroerror/eloquent-regex
9494
```
9595

96-
Later, here will be added our quick start guide.
97-
9896
Remember, regex doesn't have to be a source of frustration. With EloquentRegex, you're on your way to becoming a regex master, all while writing cleaner, more maintainable Laravel code.
9997

10098
# Basic Usage
@@ -127,7 +125,7 @@ Let's break it down:
127125
EloquentRegex::source($yourString);
128126
```
129127

130-
- **_Pattern_** Could be method for one of the ready-to-use patterns or your custom pattern (we will talk about custom pattern later). Let's keep the example simple and add url pattern:
128+
- **_Pattern_** Could be method for one of the ready-to-use patterns or your custom pattern (we will talk about custom patterns later). Let's keep the example simple and add url pattern:
131129

132130
```php
133131
EloquentRegex::source($yourString)->url();
@@ -916,13 +914,12 @@ EloquentRegex::start($string)
916914
- Lookaheads ✔️
917915
- orPattern
918916
- Raw methods
919-
- Add section in docs for "lazy" method
917+
- Add section in docs for "lazy" method
920918
- Add sections:
921919
- Testing and Debugging
922920
- Credits
923921
- Contributing (+STRUCTURE.md)
924922
- FAQs
925-
- Creating new patterns
926923

927924
##### Coming next
928925

0 commit comments

Comments
 (0)