Documentation

Author: jrean

README.md

@@ -9,6 +9,7 @@ easily handle a user verification and validate the e-mail.
 - [x] Send an e-mail with the verification token link
 - [x] Handle the verification of the token
 - [x] Set the user as verified
+- [x] Relaunch the process anytime
 
 ## Installation
 
@@ -181,54 +182,62 @@ this view to your needs.
 
 ## Usage
 
-### API
+### Routes
 
-The package public API offers three (3) methods.
+Add the two (2) default routes to the `app\Http\routes.php` file. Routes are
+customizable. If you do so, you must overwrite the corresponding available
+redirect attributes/properties listed later.
 
-* `generate(AuthenticatableContract $user)`
+```
+    Route::get('verification/error', 'Auth\AuthController@getVerificationError');
+    Route::get('verification/{token}', 'Auth\AuthController@getVerification');
+```
 
-Generate and save a verification token for the given user.
+### Trait
 
-* `send(AuthenticatableContract $user, $subject = null, $from = null, $name =
-* null)`
+The package offers two (2) traits for a quick implementation.
+Only `VerifiesUsers` must be included.
 
-Send by e-mail a link containing the verification token.
+`Jrean\UserVerification\Traits\VerifiesUsers`
 
-* `process($email, $token, $userTable)`
+which includes:
 
-Process the token verification for the given e-mail and token.
+`Jrean\UserVerification\Traits\RedirectsUsers`
 
-### Facade
+### Endpoints
 
-The package offers a facade callable with `UserVerification::`.
+The two (2) following methods are included into the `VerifiesUsers` trait and
+called by the default package routes.
 
-You can use it over the three (3) previous listed public methods.
+* `getVerification(Request $request, $token)`
 
-### Trait
+Handle the user verification.
 
-The package also offers two (2) traits for a quick implementation.
+* `getVerificationError()`
 
-`Jrean\UserVerification\Traits\VerifiesUsers`
+Do something if the verification fails.
 
-which includes:
+### API
 
-`Jrean\UserVerification\Traits\RedirectsUsers`
+The package public API offers three (3) methods.
+
+* `generate(AuthenticatableContract $user)`
 
-#### Endpoints
+Generate and save a verification token for the given user.
 
-The two following methods are endpoints you can join by defining the proper
-route(s) of your choice.
+* `send(AuthenticatableContract $user, $subject = null, $from = null, $name = null)`
 
-* `getVerification(Request $request, $token)`
+Send by e-mail a link containing the verification token.
 
-Handle the user verification. It requires a string parameter representing the
-verification token to verify.
+* `process($email, $token, $userTable)`
 
-* `getVerificationError()`
+Process the token verification for the given e-mail and token.
 
-Do something if the verification fails.
+### Facade
+
+The package offers a facade `UserVerification::`.
 
-#### Custom attributes/properties
+### Custom attributes/properties
 
 To customize the package behaviour and the redirects you can implement and
 customize six (6) attributes/properties:
@@ -257,10 +266,10 @@ Name of the view returned by the getVerificationError method.
 
 Name of the default table used for managing users.
 
-#### Custom methods
+### Custom methods/attributes/properties
 
 You can easily customize the package behaviour by overriding/overwriting the
-public methods. Dig into the source.
+public methods and the attributes/properties. Dig into the source.
 
 ## Guidelines
 
@@ -389,9 +398,7 @@ methods provided by Laravel before implementing the package.
 
 Edit the `app\Http\routes.php` file.
 
-- Define two (2) new routes. Routes are customizable.
-Don't forget to update the previous listed redirect attributes/properties if you want to
-change the pre-defined routes.
+- Define two (2) new routes.
 
 ```
     Route::get('verification/error', 'Auth\AuthController@getVerificationError');