Skip to content

Commit 9cdddaa

Browse files
authored
Merge pull request #18
Structure project documentation for installation and features
2 parents c9078ab + 4c411d7 commit 9cdddaa

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22
Multi Factor Authentication
33
CodingLibs Laravel MFA
44

5-
Compatibility
6-
- Laravel 11 and 12
7-
- PHP >= 8.2
5+
[![Packagist Version](https://img.shields.io/packagist/v/coding-libs/laravel-mfa.svg)](https://packagist.org/packages/coding-libs/laravel-mfa)
86

97
Installation
108
- Install via Composer from Packagist:
@@ -22,18 +20,22 @@ Packagist
2220
- `https://packagist.org/packages/coding-libs/laravel-mfa`
2321

2422
Features
25-
- Email and SMS one-time code challenges with pluggable channels
26-
- Google Authenticator compatible TOTP (RFC 6238) setup and verification
23+
- **Email** and **SMS** one-time code challenges with pluggable channels
24+
- Google Authenticator compatible **TOTP** (RFC 6238) setup and verification
2725
- Built-in QR code generation to display TOTP provisioning URI (uses bacon/bacon-qr-code)
2826
- Remember device support via secure, hashed tokens stored in `mfa_remembered_devices`
2927
- Simple API via `MFA` facade/service for issuing and verifying codes
3028
- Publishable config and migrations; encrypted storage of TOTP secret
3129
- Extendable channel system to add providers like WhatsApp, Twilio, etc.
3230

3331
MFA Channels
34-
- Email: delivers a one-time code via Laravel Mail
35-
- SMS: delivers a one-time code via the configured SMS driver (defaults to `log`)
36-
- TOTP: time-based one-time password compatible with Google Authenticator and similar apps
32+
- **Email**: delivers a one-time code via Laravel Mail
33+
- **SMS**: delivers a one-time code via the configured SMS driver (defaults to `log`)
34+
- **TOTP**: time-based one-time password compatible with Google Authenticator and similar apps
35+
36+
Compatibility
37+
- Laravel 11 and 12
38+
- PHP >= 8.2
3739

3840

3941
Usage

0 commit comments

Comments
 (0)