Skip to content

Commit 7c9dd0f

Browse files
committed
documentation
1 parent e109ed3 commit 7c9dd0f

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,26 @@ easily handle a user verification and validate the e-mail.
33

44
[![Latest Stable Version](https://poser.pugx.org/jrean/laravel-user-verification/v/stable)](https://packagist.org/packages/jrean/laravel-user-verification) [![Total Downloads](https://poser.pugx.org/jrean/laravel-user-verification/downloads)](https://packagist.org/packages/jrean/laravel-user-verification) [![License](https://poser.pugx.org/jrean/laravel-user-verification/license)](https://packagist.org/packages/jrean/laravel-user-verification)
55

6-
## Versions
7-
**This package is Laravel 5.3 compliant.**
6+
## VERSIONS
87

9-
For Laravel 5.3.*, use branch
10-
[3.0](https://github.com/jrean/laravel-user-verification/tree/3.0)
11-
and/or [master](https://github.com/jrean/laravel-user-verification/tree/master)
8+
**This package is Laravel 5.3 compliant.**
129

13-
For Laravel 5.0.* | 5.1.* | 5.2.*, use branch
14-
[2.2](https://github.com/jrean/laravel-user-verification/tree/2.2)
10+
| laravel/branch | [2.2](https://github.com/jrean/laravel-user-verification/tree/2.2) | [3.0](https://github.com/jrean/laravel-user-verification/tree/3.0) | [master](https://github.com/jrean/laravel-user-verification/tree/master) |
11+
|---------|-----|-----|--------|
12+
| 5.0.* | x | | |
13+
| 5.1.* | x | | |
14+
| 5.2.* | x | | |
15+
| 5.3.* | | x | x |
1516

16-
## About
17+
## ABOUT
1718

1819
- [x] Generate and store a verification token for a registered user
1920
- [x] Send or queue an e-mail with the verification token link
2021
- [x] Handle the token verification
2122
- [x] Set the user as verified
2223
- [x] Relaunch the process anytime
2324

24-
## Installation
25+
## INSTALLATION
2526

2627
This project can be installed via [Composer](http://getcomposer.org). To get
2728
the latest version of Laravel User Verification, add the following line to the
@@ -55,7 +56,7 @@ Open up `config/app.php` and add the following to the `aliases` key:
5556

5657
* `'UserVerification' => Jrean\UserVerification\Facades\UserVerification::class`
5758

58-
## Configuration
59+
## CONFIGURATION
5960

6061
Prior to use this package, the table representing the user must be updated with
6162
two new columns, `verified` and `verification_token`.
@@ -123,7 +124,7 @@ Migrate the migration with the following command:
123124
php artisan migrate
124125
```
125126

126-
## E-mail
127+
## E-MAIL
127128

128129
This package provides a method to send an e-mail with a link containing the verification token.
129130

@@ -163,7 +164,7 @@ query string with the user's e-mail as parameter.**
163164
Click here to verify your account: <a href="{{ $link = url('verification', $user->verification_token) . '?email=' . urlencode($user->email) }}"> {{ $link }}</a>
164165
```
165166

166-
## Errors
167+
## ERRORS
167168

168169
This package throws several exceptions. You are free to use `try/catch`
169170
statements or to rely on the Laravel built-in exceptions handler.
@@ -198,7 +199,7 @@ By default the `user-verification.blade.php` view will be loaded for the verific
198199

199200
The view will be available in the `resources/views/vendor/laravel-user-verification/` directory and can be customized.
200201

201-
## Usage
202+
## USAGE
202203

203204
### Routes
204205

0 commit comments

Comments
 (0)