Skip to content

Commit f1e1d44

Browse files
committed
Migration documentation
1 parent b3019c3 commit f1e1d44

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,27 +64,31 @@ the Eloquent `User` model.
6464

6565
### Migration
6666

67-
Prior to using this package, the table representing the user must be updated with two new columns, `verified` and `verification_token`. This change will be done by the migrations included with this package.
67+
The table representing the user must be updated with two new columns, `verified` and `verification_token`.
68+
This update will be performed by the migrations included with this package.
6869

6970
**It is mandatory that the two columns are on the same table where the user's e-mail is stored.**
71+
**Please make sure you do not already have those fields on your user table.**
7072

71-
The migration file this package ships with will be included when you run:
73+
Run the following command to migrate (all) the migrations, including the
74+
migration(s) provided by this package:
7275

7376
```
7477
php artisan migrate
7578
```
7679

77-
If you wish to just run the migrations from this package, run the following command.
80+
If you wish to only run the migration(s) from this package, run the following command:
7881

7982
```
8083
php artisan migrate --path=/vendor/jrean/laravel-user-verification/src/resources/migrations
8184
```
8285

83-
The package tries to guess your `user` table by checking what is set in the auth providers users settings. If this key is not found, the default `App\User` will be used to get the table name.
86+
The package tries to guess your `user` table by checking what is set in the auth providers users settings.
87+
If this key is not found, the default `App\User` will be used to get the table name.
8488

85-
The migration adds a `verification_token` and a `verified` field to the user table. Please make sure you do not already have those fields on your user table.
89+
The migration adds a `verification_token` and a `verified` field to the user table.
8690

87-
To customize the migration to your needs, publish it with the following command:
91+
To customize the migration(s) to your needs, publish them with the following command:
8892

8993
```
9094
php artisan vendor:publish --provider="Jrean\UserVerification\UserVerificationServiceProvider" --tag="migrations"

0 commit comments

Comments
 (0)