Skip to content

Commit 9ccc721

Browse files
committed
Update README.md
1 parent 7fc8085 commit 9ccc721

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -137,39 +137,36 @@ You can config your user with the `user-monitoring.php` configuration file:
137137
```php
138138
'user' => [
139139
/*
140-
* User model.
140+
* Specify the fully qualified class name of the user model.
141141
*/
142142
'model' => 'App\Models\User',
143143

144144
/*
145-
* Foreign Key column name.
145+
* Name of the foreign key column linking user data to other models.
146146
*/
147147
'foreign_key' => 'user_id',
148148

149149
/*
150-
* Users table name.
150+
* Name of the table storing user data.
151151
*/
152152
'table' => 'users',
153153

154154
/*
155-
* You can customize which guards are used to authenticate or
156-
* store user data across different parts of the application. Each guard
157-
* will be checked independently, allowing users to be authenticated by
158-
* multiple guards and enabling more flexible user management.
159-
*
160-
* Make sure that each guard is properly configured under the 'guards' section in the auth.php config file.
155+
* Defines the authentication guards used for verifying the user.
156+
* Multiple guards can be specified for flexible authentication strategies.
157+
* Ensure these guards are configured correctly in the 'guards' section of the auth.php config file.
161158
*/
162159
'guards' => ['web'],
163160

164161
/*
165-
* If you are using uuid or ulid you can change it for the type of foreign_key.
166-
*
167-
* When using ulid or uuid, you need to add related traits into the models.
162+
* Specify the type of foreign key being used (e.g., 'id', 'uuid', 'ulid').
163+
* For non-standard IDs, make sure to add the relevant traits to your models.
168164
*/
169-
'foreign_key_type' => 'id', // uuid, ulid, id
165+
'foreign_key_type' => 'id', // Options: uuid, ulid, id
170166

171167
/*
172-
* If you want to display a custom username, you can create your attribute in User and change this value.
168+
* Attribute of the user model used to display the user's name.
169+
* If you wish to use a different attribute (e.g., username), change this value accordingly.
173170
*/
174171
'display_attribute' => 'name',
175172
],

0 commit comments

Comments
 (0)