@@ -15,6 +15,29 @@ This plugin adds 2FA authentication to your Filament application. This package c
15
15
- Extendable 2FA settings component for custom pages.
16
16
- Automated test for all pages and components.
17
17
18
+ ## Installation
19
+
20
+ Thank you for purchasing Filament Two Factor Authentication Plugin!
21
+
22
+ Below, you'll find documentation on installing this plugin. If you have any questions, find a bug, need support, or have
23
+ a feature request, please don't hesitate to reach out to me at stephenjudesuccess@gmail.com .
24
+
25
+ You can install the package via composer:
26
+
27
+ ``` bash
28
+ composer require stephenjude/filament-two-factor-authentication
29
+ ```
30
+
31
+ Install the plugin migration using:
32
+ ``` bash
33
+ php artisan filament-two-factor-authentication::install
34
+ ```
35
+
36
+ Optionally, you can publish the views using
37
+ ``` bash
38
+ php artisan vendor:publish --tag=" filament-two-factor-authentication-views"
39
+ ```
40
+
18
41
## Usage
19
42
First, ensure that your application's authenticatio model uses the ` TwoFactorAuthenticatable ` trait:
20
43
@@ -48,27 +71,13 @@ public function panel(Panel $panel): Panel
48
71
...
49
72
```
50
73
51
- ## Installation
52
-
53
- Thank you for purchasing Filament Two Factor Authentication Plugin!
54
-
55
- Below, you'll find documentation on installing this plugin. If you have any questions, find a bug, need support, or have
56
- a feature request, please don't hesitate to reach out to me at stephenjudesuccess@gmail.com .
57
-
58
- You can install the package via composer:
59
-
60
- ``` bash
61
- composer require stephenjude/filament-two-factor-authentication
62
- ```
63
-
64
- Install the plugin migration using:
65
- ``` bash
66
- php artisan filament-two-factor-authentication::install
67
- ```
74
+ ### Custom 2FA Settings Page
75
+ If your application already has a user profile page, you can add a 2FA settings to your profile page view:
68
76
69
- Optionally, you can publish the views using
70
- ``` bash
71
- php artisan vendor:publish --tag=" filament-two-factor-authentication-views"
77
+ ``` php
78
+ <x-filament-panels::page >
79
+ @livewire(\Stephenjude\FilamentTwoFactorAuthentication\Livewire\TwoFactorAuthentication::class)
80
+ </x-filament-panels::page >
72
81
```
73
82
74
83
## Screenshot
0 commit comments