Merge pull request #3 from chrysanthos/update-readme

Update docs

Author: chrysanthos

README.md

@@ -5,7 +5,7 @@
 [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/chrysanthos/laravel-otp/fix-php-code-style-issues.yml?branch=main&label=code%20style)](https://github.com/chrysanthos/laravel-otp/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/chrysanthos/laravel-otp.svg?style=flat-square)](https://packagist.org/packages/chrysanthos/laravel-otp)
 
-This package lets you set up OTP verification on whenever a user is logged in.
+This package lets you set up an OTP verification process upon user login.
 
 ## Installation
 
@@ -21,15 +21,39 @@ You can publish the config file with:
 php artisan vendor:publish --tag="laravel-otp-config"
 ```
 
-This is the contents of the published config file:
+There are the contents of the published config file:
 
 ```php
 return [
 
+    /**
+     * Whether the package will register the routes and listeners.
+     */
     'enabled' => false,
 
+    /**
+     * The logo image to be shown above otp input.
+     */
+    'logo' => null,
+
+    /**
+     * The notification to be sent to the logged-in user.
+     * Override this with your own implementation so that
+     * you can customize the channels, message format etc.
+     */
     'notification' => \Chrysanthos\LaravelOtp\Notifications\SendOtpToUserNotification::class,
 
+    /**
+     * The paths that should be protected by otp. This must be
+     * relative paths with no slashes at the start of the string.
+     * Use this option in case you have admin login area with tools
+     * like Nova/Backpack/Filament and only nedd otp in the main site
+     *
+     * Sadly the paths must point to the uri path of the route that the login form is submitted to.
+     */
+    'paths' => [
+        '*',
+    ],
 ];
 ```
 
@@ -44,6 +68,8 @@ php artisan vendor:publish --tag="laravel-otp-views"
 Add the RedirectToOtpPage Middleware to the routes you wish to be protected by OTP.
 
 ```php
+use Chrysanthos\LaravelOtp\Middleware\RedirectToOtpPage;
+
 Route::middleware([
     'auth:sanctum',
     RedirectToOtpPage::class,
@@ -52,7 +78,7 @@ Route::middleware([
 });
 ```
 
-Customize the notification you wish to be sent by changing the notification key in the config.
+You may customize the notification by changing the `notification` key in the config.
 By setting the notification to a custom notification class you have full flexibility on how the notification is sent (Channels, Text, etc.)
 
 ```php