Skip to content

Commit

Permalink
->generator docs
Browse files Browse the repository at this point in the history
  • Loading branch information
0wain committed Aug 6, 2024
1 parent 626c3e0 commit 51e84ba
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ class UserResource extends Resource
### `->friendly()`

#### Description
`friendly` is a preloaded generator that creates a user friendly password. This password consists of 3 words that are combinred with '-'.
`friendly` is a preloaded generator that creates a user friendly password. This password consists of 3 words that are combinred with '-'. E.g `time-shelf-bottle`

### `->copyable($state)`

Expand All @@ -82,6 +82,14 @@ class UserResource extends Resource
#### Arguments
`state` - (optional, bool) If the password should be editable.

### `->generator($func)`

#### Description
`generator` allows you to define a custom generator that is used to create a password.

#### Arguments
`func` - (optional, closure) The function used to generate the password. This function **must** return a string.



## Author
Expand Down

0 comments on commit 51e84ba

Please sign in to comment.