From 842b053d9c7b12533f503b1dd42cf135b2f42bc9 Mon Sep 17 00:00:00 2001
From: H0llyW00dzZ <priv8@btz.pm>
Date: Thu, 30 May 2024 18:11:42 +0700
Subject: [PATCH] Docs [pkg.go.dev] Update Documentation (#88)

- [+] docs: update documentation for 2FA middleware
- [+] Add note about the requirement of c.Locals to be set before using the 2FA middleware. Provide an example of using the fiber.Ctx.Locals middleware to set c.Locals with the "email" key and value. Explain that the value set in c.Locals can be accessed in the 2FA middleware using the ContextKey specified in the configuration.
---
 docs.go | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/docs.go b/docs.go
index a629f13..bf9f7a0 100644
--- a/docs.go
+++ b/docs.go
@@ -21,6 +21,8 @@
 //
 // To use the 2FA middleware in a Fiber application, create a new instance of the middleware with the desired configuration and register it with the application.
 //
+// Note: This 2FA middleware requires c.Locals to be set before using it. Use the [fiber.Ctx.Locals] middleware to set c.Locals.
+//
 //	package main
 //
 //	import (
@@ -31,6 +33,13 @@
 //	func main() {
 //		app := fiber.New()
 //
+//		// Use the fiber.Locals middleware to set c.Locals
+//		app.Use(func(c *fiber.Ctx) error {
+//
+//		// Note: c.Locals is pretty useful and can directly store values from a database.
+//		c.Locals("email", "user@example.com")
+//		return c.Next()
+//
 //		app.Use(twofa.New(twofa.Config{
 //			Issuer:      "MyApp",
 //			ContextKey:  "email",
@@ -43,7 +52,9 @@
 //		app.Listen(":3000")
 //	}
 //
-// In the example above, a new instance of the 2FA middleware is created with a configuration that specifies the issuer name, context key, and storage provider.
+// In the example above, the fiber.Locals middleware is used to set c.Locals with the "email" key and the corresponding value. This value can be accessed in the 2FA middleware using the ContextKey specified in the configuration.
+//
+// The 2FA middleware is then created with a configuration that specifies the issuer name, context key, and storage provider.
 //
 // # Configuration
 //