From 816cb484e38947e68896314f0ba323548cbf5a75 Mon Sep 17 00:00:00 2001 From: Ashley Clarke Date: Mon, 10 Apr 2017 20:31:35 +0200 Subject: [PATCH] add info on checking an invite --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index be86146..be47f5b 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,16 @@ try { } ``` +### Check Invites without redeeming them + +You can check an invite by calling the ````check```` method. Providing the invite code and optionally an email address. (It has the same signature as the ````redeem```` method except it will return ````true```` or ````false```` instead of throwing an exception. + +```php +Doorman::check('ABCDE'); +// or +Doorman::check('ABCDE', 'me@ashleyclarke.me'); +``` + ### Change Error Messages (and translation support) In order to change the error message returned from doorman, we need to publish the language files like so: