Skip to content

Commit a76d484

Browse files
chore: update readme
1 parent 187fcf1 commit a76d484

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ starting packages, so hopefully this starter kit has a good value. Any PRs
99
regarding improvement to the starting kit is welcome.
1010

1111
To-do:
12-
- [ ] Basic Authentication
12+
- [x] Basic Authentication
13+
- [ ] User control to edit the user's information via Dashboard
1314

1415
The package includes:
1516
- Laravel mix (to mimic Laravel's asset compiling)
@@ -24,4 +25,11 @@ The package includes:
2425
- Clone this project.
2526
- Run `composer install`.
2627
- Run `npm install`.
27-
- Run `npm run dev` or `npm run watch` to compile assets.
28+
- Run `npm run dev` or `npm run watch` to compile assets.
29+
30+
## Authentication
31+
The authentication method is based on the `User` model. Inside the
32+
`LoginController`, the `LoginUser` service will set the user's information to
33+
the session. In default, the authentication only provide `username` as the
34+
authentication key, you can override the key for whatever you like such as
35+
`email`, but you have to make sure that field is exists in the `users` table.

0 commit comments

Comments
 (0)