Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffgreco13 authored Oct 17, 2022
1 parent c3ec6e2 commit 561e86a
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ The missing toolkit from Filament Admin with Breeze-like functionality. Includes
![Screenshot of Password confirmation action](./art/confirm-password.png)
![Screenshot of Sanctum tokens](./art/sanctum.png)

## Warning: Jetstream or Breeze Users

Please read the [Routing instructions](#routing) before installing to ensure that Filament Breezy will suit your needs.


## Installation

1. Install the package via composer:
Expand Down Expand Up @@ -91,8 +96,14 @@ class User extends Authenticatable

### Routing

*IMPORTANT NOTE*
Breezy uses the default Laravel Auth routes, such as `password.request` and `password.reset` in order to deliver a seamless experience with Laravel Auth. If you are using Jetstream, Breeze, or another plugin that uses the default auth routes then you may experience unexpected behaviour.
*COMPATIBILITY WARNING*
Breezy uses the default Laravel Auth routes, `register`, `login`, `password.request`, `password.reset`, `verification.verify` and `verifciation.notice` in order to deliver a seamless experience with Laravel Auth. If you are using Jetstream, Breeze, or another plugin that uses the default auth routes then you will get an error that the routes are already registered.

You can use the `"route_group_prefix"=>'',` option in the Filament Breezy config file to set a name prefix for all of Breezy's routes. Ex. `"route_group_prefix"=>'breezy.',`

However, since Breezy uses Laravel Auth to generate password reset and email verfication emails you will need to customize these emails to use the appropriate routes. For example, a user resetting their password from Filament Breezy will receive an email directing them to the `password.reset` route because Laravel Auth generates the URL in this email automatically.

Please see instructions for [Password Reset Customization](https://laravel.com/docs/9.x/passwords#password-customization) and [Email Verification Customization](https://laravel.com/docs/9.x/verification#customization) for instructions on how to customize these URLs to suit your needs.

### Customizing Password Rules

Expand Down

0 comments on commit 561e86a

Please sign in to comment.