Skip to content

Commit 5449d64

Browse files
committed
Update README.md
1 parent 969afca commit 5449d64

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,11 @@ php artisan vendor:publish --provider="AlwaysOpen\AuthNotifications\AuthNotifica
2323

2424
## Usage
2525

26-
```php
26+
By default all of the notifications are turned off. To enable them, declare the appropriate environment variable like `AUTH_NOTIFICATIONS_LOGIN_VALIDATED=true`. Framework login events track the `Illuminate\Auth\Events\Validated`, `Illuminate\Auth\Events\Failed`, and `Illuminate\Auth\Events\Lockout` events.
2727

28-
```
28+
For credential notifications, we are simply watching the user model for changes. If you'd rather fire those events manually, set the corresponding field to a blank string and dispatch `AlwaysOpen\AuthNotifications\Events\LoginWasChanged`, `AlwaysOpen\AuthNotifications\Events\PasswordWasChanged`, `AlwaysOpen\AuthNotifications\Events\TwoFactorWasEnabled`, or `AlwaysOpen\AuthNotifications\Events\TwoFactorWasDisabled` with the only parameter being the user object to send to.
29+
30+
You may also override the notifications that are sent by creating your own notifications via `php artisan make:notification` and overriding the class defined in the `config/auth-notifications.php`.
2931

3032
## Testing
3133

0 commit comments

Comments
 (0)