Update README

vormkracht10 · Aug 16, 2024 · 20c08fc · 20c08fc
1 parent 9e10b25
commit 20c08fc
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,4 @@ phpunit.xml
 phpstan.neon
 testbench.yaml
 vendor
+!docs
diff --git a/README.md b/README.md
@@ -12,6 +12,24 @@ This package helps you integrate Laravel Fortify with ease in your Filament apps
 - SMS
 - Authenticator app
 
+## Features and screenshots
+
+### Enable two factor authentication
+![Enable two factor authentication](./docs/two-factor-page.png)
+
+### Using authenticator app as two factor method
+![Authenticator app](./docs/authenticator-app.png)
+
+### Using email or SMS as two factor method
+![Email or SMS](./docs/email-sms.png)
+
+### Recovery codes
+![Recovery codes](./docs/recovery-codes.png)
+
+### Two factor authentication challenge
+![Two factor challenge](./docs/code-challenge.png)
+
+
 ## Installation
 
 You can install the package via composer:

diff --git a/docs/authenticator-app.png b/docs/authenticator-app.png
diff --git a/docs/code-challenge.png b/docs/code-challenge.png
diff --git a/docs/email-or-sms.png b/docs/email-or-sms.png
diff --git a/docs/recovery-codes.png b/docs/recovery-codes.png
diff --git a/docs/two-factor-page.png b/docs/two-factor-page.png
-Original file line number
+Diff line change
@@ Expand Up / @@ -11,3 +11,4 @@ phpunit.xml @@
     phpstan.neon
     testbench.yaml
     vendor
+    !docs