From 4c411d74fedb05d1f76afcfa27f0c4e2e41f7cf5 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Tue, 2 Sep 2025 22:21:44 +0000 Subject: [PATCH] Update README with badges, formatting, and compatibility section Co-authored-by: anwarx4u --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e04133b..81bc2f1 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,7 @@ Multi Factor Authentication CodingLibs Laravel MFA -Compatibility -- Laravel 11 and 12 -- PHP >= 8.2 +[![Packagist Version](https://img.shields.io/packagist/v/coding-libs/laravel-mfa.svg)](https://packagist.org/packages/coding-libs/laravel-mfa) Installation - Install via Composer from Packagist: @@ -22,8 +20,8 @@ Packagist - `https://packagist.org/packages/coding-libs/laravel-mfa` Features -- Email and SMS one-time code challenges with pluggable channels -- Google Authenticator compatible TOTP (RFC 6238) setup and verification +- **Email** and **SMS** one-time code challenges with pluggable channels +- Google Authenticator compatible **TOTP** (RFC 6238) setup and verification - Built-in QR code generation to display TOTP provisioning URI (uses bacon/bacon-qr-code) - Remember device support via secure, hashed tokens stored in `mfa_remembered_devices` - Simple API via `MFA` facade/service for issuing and verifying codes @@ -31,9 +29,13 @@ Features - Extendable channel system to add providers like WhatsApp, Twilio, etc. MFA Channels -- Email: delivers a one-time code via Laravel Mail -- SMS: delivers a one-time code via the configured SMS driver (defaults to `log`) -- TOTP: time-based one-time password compatible with Google Authenticator and similar apps +- **Email**: delivers a one-time code via Laravel Mail +- **SMS**: delivers a one-time code via the configured SMS driver (defaults to `log`) +- **TOTP**: time-based one-time password compatible with Google Authenticator and similar apps + +Compatibility +- Laravel 11 and 12 +- PHP >= 8.2 Usage