Add docs from gofiber/contrib@69eaeb4

gofiber · Aug 3, 2023 · bf0b272 · bf0b272
1 parent 7e9b6d4
commit bf0b272
Show file tree

Hide file tree

Showing 12 changed files with 35 additions and 6 deletions.
diff --git a/docs/contrib/casbin/README.md b/docs/contrib/casbin/README.md
@@ -12,6 +12,8 @@ id: casbin
 
 Casbin middleware for Fiber.
 
+**Note: Requires Go 1.18 and above**
+
 ## Install
 ```
 go get -u github.com/gofiber/fiber/v2

diff --git a/docs/contrib/fiberi18n/README.md b/docs/contrib/fiberi18n/README.md
@@ -12,6 +12,8 @@ id: fiberi18n
 
 [go-i18n](https://github.com/nicksnyder/go-i18n) support for Fiber.
 
+**Note: Requires Go 1.18 and above**
+
 ## Install
 
 This middleware supports Fiber v2.

diff --git a/docs/contrib/fibernewrelic/README.md b/docs/contrib/fibernewrelic/README.md
@@ -12,6 +12,8 @@ id: fibernewrelic
 
 [NewRelic](https://github.com/newrelic/go-agent) support for Fiber.
 
+**Note: Requires Go 1.18 and above**
+
 ## Install
 
 ```

diff --git a/docs/contrib/fibersentry/README.md b/docs/contrib/fibersentry/README.md
@@ -12,6 +12,8 @@ id: fibersentry
 
 [Sentry](https://sentry.io/) support for Fiber.
 
+**Note: Requires Go 1.18 and above**
+
 ## Install
 
 This middleware supports Fiber v2.

diff --git a/docs/contrib/fiberzap/README.md b/docs/contrib/fiberzap/README.md
@@ -12,13 +12,15 @@ id: fiberzap
 
 [Zap](https://github.com/uber-go/zap) logging support for Fiber.
 
+**Note: Requires Go 1.19 and above**
+
 ## Install
 
 This middleware supports Fiber v2.
 
 ```
 go get -u github.com/gofiber/fiber/v2
-go get -u github.com/gofiber/contrib/fiberzap
+go get -u github.com/gofiber/contrib/fiberzap/v2
 go get -u go.uber.org/zap
 ```
 
@@ -48,7 +50,7 @@ import (
     "log"
 
     "github.com/gofiber/fiber/v2"
-    "github.com/gofiber/contrib/fiberzap"
+    "github.com/gofiber/contrib/fiberzap/v2"
     "go.uber.org/zap"
 )
 
@@ -93,7 +95,7 @@ package main
 
 import (
 	"context"
-	"github.com/gofiber/contrib/fiberzap"
+	"github.com/gofiber/contrib/fiberzap/v2"
 	"github.com/gofiber/fiber/v2"
 	"github.com/gofiber/fiber/v2/log"
 )

diff --git a/docs/contrib/fiberzerolog/README.md b/docs/contrib/fiberzerolog/README.md
@@ -12,6 +12,8 @@ id: fiberzerolog
 
 [Zerolog](https://zerolog.io/) logging support for Fiber.
 
+**Note: Requires Go 1.18 and above**
+
 ## Install
 
 This middleware supports Fiber v2.

diff --git a/docs/contrib/jwt/README.md b/docs/contrib/jwt/README.md
@@ -17,6 +17,8 @@ For missing token, it returns "400 - Bad Request" error.
 
 Special thanks and credits to [Echo](https://echo.labstack.com/middleware/jwt)
 
+**Note: Requires Go 1.19 and above**
+
 ## Install
 
 This middleware supports Fiber v1 & v2, install accordingly.

diff --git a/docs/contrib/opafiber/README.md b/docs/contrib/opafiber/README.md
@@ -12,13 +12,13 @@ id: opafiber
 
 [Open Policy Agent](https://github.com/open-policy-agent/opa) support for Fiber.
 
-**Note: Requires Go 1.18 and above**
+**Note: Requires Go 1.19 and above**
 
 ## Install
 
 ```
 go get -u github.com/gofiber/fiber/v2
-go get -u github.com/gofiber/contrib/opafiber
+go get -u github.com/gofiber/contrib/opafiber/v2
 ```
 
 ## Signature
@@ -69,7 +69,7 @@ package main
 
 import (
 	"github.com/gofiber/fiber/v2"
-	"github.com/gofiber/contrib/opafiber"
+	"github.com/gofiber/contrib/opafiber/v2"
 )
 
 func main() {

diff --git a/docs/contrib/otelfiber/README.md b/docs/contrib/otelfiber/README.md
@@ -14,6 +14,8 @@ id: otelfiber
 
 Can be found on [OpenTelemetry Registry](https://opentelemetry.io/registry/instrumentation-go-fiber/).
 
+**Note: Requires Go 1.19 and above**
+
 ## Install
 
 This middleware supports Fiber v2.

diff --git a/docs/contrib/paseto/README.md b/docs/contrib/paseto/README.md
@@ -16,6 +16,8 @@ PASETO returns a Web Token (PASETO) auth middleware.
 - For invalid token, it returns "401 - Unauthorized" error.
 - For missing token, it returns "400 - BadRequest" error.
 
+**Note: Requires Go 1.18 and above**
+
 ## Install
 
 This middleware supports Fiber v2.

diff --git a/docs/contrib/swagger/README.md b/docs/contrib/swagger/README.md
@@ -12,6 +12,15 @@ id: swagger
 
 Swagger middleware for [Fiber](https://github.com/gofiber/fiber). The middleware handles Swagger UI. 
 
+**Note: Requires Go 1.18 and above**
+
+## Install
+
+```
+go get -u github.com/gofiber/fiber/v2
+go get -u github.com/gofiber/contrib/swagger
+```
+
 ## Signatures
 ```go
 func New(config ...swagger.Config) fiber.Handler

diff --git a/docs/contrib/websocket/README.md b/docs/contrib/websocket/README.md
@@ -12,6 +12,8 @@ id: websocket
 
 Based on [Fasthttp WebSocket](https://github.com/fasthttp/websocket) for [Fiber](https://github.com/gofiber/fiber) with available `*fiber.Ctx` methods like [Locals](http://docs.gofiber.io/ctx#locals), [Params](http://docs.gofiber.io/ctx#params), [Query](http://docs.gofiber.io/ctx#query) and [Cookies](http://docs.gofiber.io/ctx#cookies).
 
+**Note: Requires Go 1.18 and above**
+
 ## Install
 
 ```