Skip to content

Commit 3aaf88f

Browse files
committed
Documentation
1 parent 8d38a84 commit 3aaf88f

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -157,17 +157,13 @@ The package also offers a trait for a quick implementation.
157157

158158
#### Actions
159159

160-
The three following methods are endpoints you can join by defining the proper
160+
The two following methods are endpoints you can join by defining the proper
161161
route(s) of your choice.
162162

163-
* `getVerificationToken()`
164-
165-
Handle the verification token generation.
166-
167163
* `getVerification($token)`
168164

169-
Handle the user verification. It requires a string parameter that should
170-
represent the verification token to verify.
165+
Handle the user verification. It requires a string parameter representing the
166+
verification token to verify.
171167

172168
* `getVerificationError()`
173169

@@ -176,7 +172,7 @@ Do something if the verification fails.
176172
#### Custom attributes/properties
177173

178174
To customize the package behaviour and the redirects you can implement and
179-
customize five (5) attributes/properties:
175+
customize five (6) attributes/properties:
180176

181177
* `$redirectIfVerified = '/';`
182178

@@ -192,7 +188,7 @@ Where to redirect after a successful verification token verification.
192188

193189
* `$redirectIfVerificationFails = '/auth/verification/error';`
194190

195-
Where to redirect after a failling verification token verification.
191+
Where to redirect after a failling token verification.
196192

197193
* `$verifiationErrorView = 'errors.user-verification';`
198194

@@ -296,8 +292,9 @@ Edit the `app\Http\routes.php` file.
296292

297293
## Contribute
298294

299-
This package is (yet) under active development and refactoring.
300-
Please, feel free to comment, contribute and help.
295+
This package is (yet) under development and refactoring but is ready for
296+
production. Please, feel free to comment, contribute and help. I will be happy
297+
to get some help to deliver tests.
301298

302299
## License
303300

0 commit comments

Comments
 (0)