document the 2 helper functions

ziming · Jan 25, 2024 · b611c84 · b611c84
1 parent 521d393
commit b611c84
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -46,7 +46,11 @@ LaravelEmailSniperLink::getSniperLinkQuick('[email protected]', 'optional-from-
 LaravelEmailSniperLink::getSniperLink('[email protected]', '[email protected]')
 ```
 
-In the future I may add helper functions. The `LaravelEmailSniperLink` class has more static methods as well which might be useful for you
+The `LaravelEmailSniperLink` class has more static methods as well which might be useful for you.
+
+Some helper functions are also available. For now there are 2. `email_sniper_link_quick(string $receiverEmail, ?string $fromEmail = null)` and `email_sniper_link(string $receiverEmail, ?string $fromEmail = null)`.
+
+```php
 
 ## Testing
 

diff --git a/src/helpers.php b/src/helpers.php
@@ -12,6 +12,9 @@ function sniper_link_quick(string $receiverEmail, ?string $fromEmail = null): ?s
 }
 
 if (! function_exists('email_sniper_link')) {
+    /**
+     * @throws \Detection\Exception\MobileDetectException
+     */
     function sniper_link_quick(string $receiverEmail, ?string $fromEmail = null): ?string
     {
         return LaravelEmailSniperLink::getSniperLink($receiverEmail, $fromEmail);