Merge pull request #677 from gofiber/update-docs

update READMEs
gofiber · Jul 6, 2023 · 9b62721 · 9b62721
2 parents 8f7ee69 + 21feede
commit 9b62721
Show file tree

Hide file tree

Showing 14 changed files with 80 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 ![Security](https://github.com/gofiber/contrib/workflows/Security/badge.svg)
 ![Linter](https://github.com/gofiber/contrib/workflows/Linter/badge.svg)
 
-Repository for third party middlewares with dependencies
+Repository for third party middlewares with dependencies.
 
 ## 📑 Middleware Implementations
 

diff --git a/casbin/README.md b/casbin/README.md
@@ -1,5 +1,15 @@
-### Casbin
-Casbin middleware for Fiber
+---
+id: casbin
+title: Casbin
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/contrib?filter=casbin*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://github.com/gofiber/contrib/workflows/Tests/badge.svg)
+![Security](https://github.com/gofiber/contrib/workflows/Security/badge.svg)
+![Linter](https://github.com/gofiber/contrib/workflows/Linter/badge.svg)
+
+Casbin middleware for Fiber.
 
 ### Install
 ```

diff --git a/fiberi18n/README.md b/fiberi18n/README.md
@@ -1,6 +1,9 @@
-# Fiberi18n
+---
+id: fiberi18n
+title: Fiberi18n
+---
 
-![Release](https://img.shields.io/github/release/gofiber/contrib.svg)
+![Release](https://img.shields.io/github/v/tag/gofiber/contrib?filter=fiberi18n*)
 [![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
 ![Test](https://github.com/gofiber/contrib/workflows/Tests/badge.svg)
 ![Security](https://github.com/gofiber/contrib/workflows/Security/badge.svg)

diff --git a/fibernewrelic/README.md b/fibernewrelic/README.md
@@ -1,5 +1,9 @@
-### NewRelic
-![Release](https://img.shields.io/github/release/gofiber/contrib.svg)
+---
+id: fibernewrelic
+title: Fibernewrelic
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/contrib?filter=fibernewrelic*)
 [![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
 ![Test](https://github.com/gofiber/contrib/workflows/Tests/badge.svg)
 ![Security](https://github.com/gofiber/contrib/workflows/Security/badge.svg)

diff --git a/fibersentry/README.md b/fibersentry/README.md
@@ -1,6 +1,9 @@
-# Fibersentry
+---
+id: fibersentry
+title: Fibersentry
+---
 
-![Release](https://img.shields.io/github/release/gofiber/contrib.svg)
+![Release](https://img.shields.io/github/v/tag/gofiber/contrib?filter=fibersentry*)
 [![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
 ![Test](https://github.com/gofiber/contrib/workflows/Tests/badge.svg)
 ![Security](https://github.com/gofiber/contrib/workflows/Security/badge.svg)

diff --git a/fiberzap/README.md b/fiberzap/README.md
@@ -1,6 +1,9 @@
-# Fiberzap
+---
+id: fiberzap
+title: Fiberzap
+---
 
-![Release](https://img.shields.io/github/release/gofiber/contrib.svg)
+![Release](https://img.shields.io/github/v/tag/gofiber/contrib?filter=fiberzap*)
 [![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
 ![Test](https://github.com/gofiber/contrib/workflows/Tests/badge.svg)
 ![Security](https://github.com/gofiber/contrib/workflows/Security/badge.svg)

diff --git a/fiberzerolog/README.md b/fiberzerolog/README.md
@@ -1,6 +1,9 @@
-# Fiberzerolog
+---
+id: fiberzerolog
+title: Fiberzerolog
+---
 
-![Release](https://img.shields.io/github/release/gofiber/contrib.svg)
+![Release](https://img.shields.io/github/v/tag/gofiber/contrib?filter=fiberzerolog*)
 [![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
 ![Test](https://github.com/gofiber/contrib/workflows/Tests/badge.svg)
 ![Security](https://github.com/gofiber/contrib/workflows/Security/badge.svg)

diff --git a/jwt/README.md b/jwt/README.md
@@ -1,6 +1,9 @@
-# JSON Web Tokens
+---
+id: jwt
+title: JWT
+---
 
-![Release](https://img.shields.io/github/release/gofiber/contrib.svg)
+![Release](https://img.shields.io/github/v/tag/gofiber/contrib?filter=jwt*)
 [![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
 ![Test](https://github.com/gofiber/contrib/workflows/Tests/badge.svg)
 ![Security](https://github.com/gofiber/contrib/workflows/Security/badge.svg)

diff --git a/opafiber/README.md b/opafiber/README.md
@@ -1,6 +1,9 @@
-### Open Policy Agent
+---
+id: opafiber
+title: Opafiber
+---
 
-![Release](https://img.shields.io/github/release/gofiber/contrib.svg)
+![Release](https://img.shields.io/github/v/tag/gofiber/contrib?filter=opafiber*)
 [![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
 ![Test](https://github.com/gofiber/contrib/workflows/Tests/badge.svg)
 ![Security](https://github.com/gofiber/contrib/workflows/Security/badge.svg)

diff --git a/otelfiber/README.md b/otelfiber/README.md
@@ -1,6 +1,9 @@
-# Otelfiber
+---
+id: otelfiber
+title: Otelfiber
+---
 
-![Release](https://img.shields.io/github/release/gofiber/contrib.svg)
+![Release](https://img.shields.io/github/v/tag/gofiber/contrib?filter=otelfiber*)
 [![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
 ![Test](https://github.com/gofiber/contrib/workflows/Tests/badge.svg)
 ![Security](https://github.com/gofiber/contrib/workflows/Security/badge.svg)

diff --git a/otelfiber/example/README.md b/otelfiber/example/README.md
@@ -1,4 +1,7 @@
-# gofiber fiber instrumentation example
+---
+id: otelfiber-example
+title: Otelfiber Example
+---
 
 An HTTP server using gofiber fiber and instrumentation. The server has a
 `/users/:id` endpoint. The server generates span information to

diff --git a/paseto/README.md b/paseto/README.md
@@ -1,6 +1,9 @@
-# PASETO (Platform-Agnostic SEcurity TOkens)
+---
+id: paseto
+title: Paseto
+---
 
-![Release](https://img.shields.io/github/release/gofiber/contrib.svg)
+![Release](https://img.shields.io/github/v/tag/gofiber/contrib?filter=paseto*)
 [![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
 ![Test](https://github.com/gofiber/contrib/workflows/Tests/badge.svg)
 ![Security](https://github.com/gofiber/contrib/workflows/Security/badge.svg)

diff --git a/swagger/README.md b/swagger/README.md
@@ -1,4 +1,14 @@
-# Swagger
+---
+id: swagger
+title: Swagger
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/contrib?filter=swagger*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://github.com/gofiber/contrib/workflows/Tests/badge.svg)
+![Security](https://github.com/gofiber/contrib/workflows/Security/badge.svg)
+![Linter](https://github.com/gofiber/contrib/workflows/Linter/badge.svg)
+
 Swagger middleware for [Fiber](https://github.com/gofiber/fiber). The middleware handles Swagger UI. 
 
 ### Table of Contents

diff --git a/websocket/README.md b/websocket/README.md
@@ -1,7 +1,10 @@
-# WebSocket
+---
+id: websocket
+title: Websocket
+---
 
-![Release](https://img.shields.io/github/release/gofiber/websocket.svg)
-[![Discord](https://img.shields.io/badge/discord-join%20channel-7289DA)](https://gofiber.io/discord)
+![Release](https://img.shields.io/github/v/tag/gofiber/contrib?filter=websocket*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
 ![Test](https://github.com/gofiber/contrib/workflows/Tests/badge.svg)
 ![Security](https://github.com/gofiber/contrib/workflows/Security/badge.svg)
 ![Linter](https://github.com/gofiber/contrib/workflows/Linter/badge.svg)