Skip to content

Commit

Permalink
v3: Update Version Numbers in Docs (#2853)
Browse files Browse the repository at this point in the history
* 📚 Docs: Update version numbers for v3

* 📚 Docs: Update template docs to reflect changes in #2848

---------

Co-authored-by: Juan Calderon-Perez <835733+gaby@users.noreply.github.com>
  • Loading branch information
nickajacks1 and gaby committed Feb 11, 2024
1 parent 535e5c6 commit 18f0f87
Show file tree
Hide file tree
Showing 23 changed files with 113 additions and 113 deletions.
4 changes: 2 additions & 2 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ These tests are performed by [TechEmpower](https://www.techempower.com/benchmark

## ⚙️ Installation

Make sure you have Go installed ([download](https://go.dev/dl/)). Version `1.17` or higher is required.
Make sure you have Go installed ([download](https://go.dev/dl/)). Version `1.20` or higher is required.

Initialize your project by creating a folder and then running `go mod init github.com/your/repo` ([learn more](https://go.dev/blog/using-go-modules)) inside the folder. Then install Fiber with the [`go get`](https://pkg.go.dev/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them) command:

Expand Down Expand Up @@ -165,7 +165,7 @@ We **listen** to our users in [issues](https://github.com/gofiber/fiber/issues),

## ⚠️ Limitations

- Due to Fiber's usage of unsafe, the library may not always be compatible with the latest Go version. Fiber 2.40.0 has been tested with Go versions 1.17 to 1.21.
- Due to Fiber's usage of unsafe, the library may not always be compatible with the latest Go version. Fiber 3.0.0 has been tested with Go versions 1.20 to 1.22.
- Fiber is not compatible with net/http interfaces. This means you will not be able to use projects like gqlgen, go-swagger, or any others which are part of the net/http ecosystem.

## 👀 Examples
Expand Down
36 changes: 18 additions & 18 deletions .github/README_az.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,10 @@
<img height="20px" src="https://img.shields.io/badge/PL-flag.svg?color=555555&style=flat-square&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxMjgwIDgwMCI+DQo8cGF0aCBmaWxsPSIjZTllOGU3IiBkPSJtMCwwaDEyODB2NDAwaC0xMjgweiIvPg0KPHBhdGggZmlsbD0iI2Q0MjEzZCIgZD0ibTAsNDAwaDEyODB2NDAwaC0xMjgweiIvPg0KPC9zdmc+DQo=">
</a>
<br>
<a href="https://pkg.go.dev/github.com/gofiber/fiber/v2#pkg-overview">
<a href="https://pkg.go.dev/github.com/gofiber/fiber/v3#pkg-overview">
<img src="https://img.shields.io/badge/%F0%9F%93%9A%20godoc-pkg-00ACD7.svg?color=00ACD7&style=flat-square">
</a>
<a href="https://goreportcard.com/report/github.com/gofiber/fiber/v2">
<a href="https://goreportcard.com/report/github.com/gofiber/fiber/v3">
<img src="https://img.shields.io/badge/%F0%9F%93%9D%20goreport-A%2B-75C46B?style=flat-square">
</a>
<a href="https://gocover.io/github.com/gofiber/fiber">
Expand Down Expand Up @@ -105,7 +105,7 @@
```go
package main

import "github.com/gofiber/fiber/v2"
import "github.com/gofiber/fiber/v3"

func main() {
app := fiber.New()
Expand All @@ -129,12 +129,12 @@ Bu testlər [TechEmpower](https://www.techempower.com/benchmarks/#section=data-r

## ⚙️ Quraşdırılması

Go dilinin `1.17` və ya daha yuxarı versiyanın [yükləndiyindən](https://go.dev/dl/) əmin olun.
Go dilinin `1.20` və ya daha yuxarı versiyanın [yükləndiyindən](https://go.dev/dl/) əmin olun.

Bir qovluq yaratdıqdan sonra, `go mod init github.com/your/repo` komandasını eyni qovluğun daxilində işə salaraq layihənizi başladın ([go modulları haqqında əlavə bilgilər](https://go.dev/blog/using-go-modules)). Növbəti addım olaraq Fiber-i [`go get`](https://pkg.go.dev/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them) komandasını işlədərək yükləyin:

```bash
go get -u github.com/gofiber/fiber/v2
go get -u github.com/gofiber/fiber/v3
```

## 🎯 Özəllikləri
Expand Down Expand Up @@ -164,7 +164,7 @@ Biz istifadəçilərdən gələn [issue-a](https://github.com/gofiber/fiber/issu

## ⚠️ Limitlər

- Fiber unsafe prinsiplərə əsaslanaraq çalışdığından, o hər zaman Go-nun son versiyası ilə uyğunlaşmaya bilər. Buna görə də, Fiber 2.40.0 — Go 1.17 və 1.21 versiyaları ilə test edilərək saz vəziyyətə gətirilmişdir.
- Fiber unsafe prinsiplərə əsaslanaraq çalışdığından, o hər zaman Go-nun son versiyası ilə uyğunlaşmaya bilər. Buna görə də, Fiber 3.0.0 — Go 1.20 və 1.22 versiyaları ilə test edilərək saz vəziyyətə gətirilmişdir.
- Fiber net/http interfeysləri ilə uyğun deyil. Yəni gqlgen, go-swagger kimi net/http ekosisteminin parçası olan layihələri istifadə edə bilməzsiniz.

## 👀 Misallar
Expand Down Expand Up @@ -312,7 +312,7 @@ Fiber baxış mühərriki təyin edilmədikdə [html/template-in](https://pkg.go
package main

import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/template/pug"
)

Expand Down Expand Up @@ -379,8 +379,8 @@ package main
import (
"log"

"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/logger"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/logger"
)

func main() {
Expand All @@ -402,8 +402,8 @@ func main() {
import (
"log"

"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/cors"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/cors"
)

func main() {
Expand Down Expand Up @@ -487,8 +487,8 @@ func main() {

```go
import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/websocket"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/websocket"
)

func main() {
Expand Down Expand Up @@ -521,7 +521,7 @@ func main() {

```go
import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v3"
"github.com/valyala/fasthttp"
)

Expand Down Expand Up @@ -562,8 +562,8 @@ func main() {

```go
import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/recover"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/recover"
)

func main() {
Expand All @@ -587,8 +587,8 @@ func main() {

```go
import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/recover"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/recover"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion .github/README_ckb.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ func main() {

## ⚙️ دامەزراندن

دڵنیا بە لەوەی کە لەناو ئامێرەکەت Go دامەزراوە ([دای بگرە](https://go.dev/dl/)). دەبێت وەشانەکەشی `1.17` یان سەرووتر بێت.
دڵنیا بە لەوەی کە لەناو ئامێرەکەت Go دامەزراوە ([دای بگرە](https://go.dev/dl/)). دەبێت وەشانەکەشی `1.20` یان سەرووتر بێت.

پڕۆژەکەت دەست پێ بکە بە دروستکردنی بوخچەیەک و کار پێ کردنی فەرمانی `go mod init github.com/your/repo` ([زیاتر](https://go.dev/blog/using-go-modules)) لەناو بوخچەکە. دواتریش بەم فەرمانەی خوارەوە فایبەر دامەزرێنە:

Expand Down
4 changes: 2 additions & 2 deletions .github/README_de.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Diese Tests wurden von [TechEmpower](https://www.techempower.com/benchmarks/#sec

## ⚙️ Installation

Stelle sicher, dass du Go installiert hast ([Download hier](https://go.dev/dl/)). Version `1.17` oder neuer wird zu der Nutzung Fibers benötigt.
Stelle sicher, dass du Go installiert hast ([Download hier](https://go.dev/dl/)). Version `1.20` oder neuer wird zu der Nutzung Fibers benötigt.

Erstelle ein neues Project, indem du zunächst einen neuen Ordner erstellst und dort in diesem Ordner `go mod init github.com/dein/repo` ausführst ([hier mehr dazu](https://go.dev/blog/using-go-modules)). Daraufhin kannst du Fiber mit dem [`go get`](https://pkg.go.dev/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them) Kommandozeilenbefehl installieren:

Expand Down Expand Up @@ -160,7 +160,7 @@ Fiber ist **inspiriert** von Express.js, dem beliebtesten Web-Framework im Inter

## ⚠️ Limitations

- Due to Fiber's usage of unsafe, the library may not always be compatible with the latest Go version. Fiber 2.40.0 has been tested with Go versions 1.17 to 1.21.
- Due to Fiber's usage of unsafe, the library may not always be compatible with the latest Go version. Fiber 3.0.0 has been tested with Go versions 1.20 to 1.22.
- Fiber is not compatible with net/http interfaces. This means you will not be able to use projects like gqlgen, go-swagger, or any others which are part of the net/http ecosystem.

## 👀 Beispiele
Expand Down
36 changes: 18 additions & 18 deletions .github/README_eg.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@
<img height="20px" src="https://img.shields.io/badge/PL-flag.svg?color=555555&style=flat-square&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxMjgwIDgwMCI+DQo8cGF0aCBmaWxsPSIjZTllOGU3IiBkPSJtMCwwaDEyODB2NDAwaC0xMjgweiIvPg0KPHBhdGggZmlsbD0iI2Q0MjEzZCIgZD0ibTAsNDAwaDEyODB2NDAwaC0xMjgweiIvPg0KPC9zdmc+DQo=">
</a>
<br>
<a href="https://pkg.go.dev/github.com/gofiber/fiber/v2#pkg-overview">
<a href="https://pkg.go.dev/github.com/gofiber/fiber/v3#pkg-overview">
<img src="https://img.shields.io/badge/%F0%9F%93%9A%20godoc-pkg-00ACD7.svg?color=00ACD7&style=flat-square">
</a>
<a href="https://goreportcard.com/report/github.com/gofiber/fiber/v2">
<a href="https://goreportcard.com/report/github.com/gofiber/fiber/v3">
<img src="https://img.shields.io/badge/%F0%9F%93%9D%20goreport-A%2B-75C46B?style=flat-square">
</a>
<a href="https://gocover.io/github.com/gofiber/fiber">
Expand Down Expand Up @@ -106,7 +106,7 @@
```go
package main

import "github.com/gofiber/fiber/v2"
import "github.com/gofiber/fiber/v3"

func main() {
app := fiber.New()
Expand All @@ -130,12 +130,12 @@ func main() {

## ⚙️ التسطيب

أتأكد انك مسطب جو ([تحميل](https://go.dev/dl/)). الاصدار `1.17` او اعلى.
أتأكد انك مسطب جو ([تحميل](https://go.dev/dl/)). الاصدار `1.20` او اعلى.

ابدأ البروجكت بتاعك بعمل فولدر وبعدين رن الكوماند ده `go mod init github.com/your/repo` ([اعرف اكتر](https://go.dev/blog/using-go-modules)) بعدين سطب فايبر بكوماند [`go get`](https://pkg.go.dev/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them):

```bash
go get -u github.com/gofiber/fiber/v2
go get -u github.com/gofiber/fiber/v3
```

## 🎯 المميزات
Expand Down Expand Up @@ -164,7 +164,7 @@ go get -u github.com/gofiber/fiber/v2

## ⚠️ القيود

- بسبب استخدام فايبر لـunsafe ممكن انها متتوافقش مع اخر اصدار من جو. فايبر 2.40.0 اتتست بـجو من اصدار 1.17 لـ1.21
- بسبب استخدام فايبر لـunsafe ممكن انها متتوافقش مع اخر اصدار من جو. فايبر 3.0.0 اتتست بـجو من اصدار 1.20 لـ1.22
- فايبر مش متوافقة مع واجهات net/http. ده يعني انك مش هتقدر تستخدم مشاريع زي gqlgen, go-swagger, او اي حاجة تانية متعلقة بـnet/http

## 👀 أمثلة
Expand Down Expand Up @@ -312,7 +312,7 @@ func main() {
package main

import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/template/pug"
)

Expand Down Expand Up @@ -379,8 +379,8 @@ package main
import (
"log"

"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/logger"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/logger"
)

func main() {
Expand All @@ -402,8 +402,8 @@ func main() {
import (
"log"

"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/cors"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/cors"
)

func main() {
Expand Down Expand Up @@ -487,8 +487,8 @@ func main() {

```go
import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/websocket"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/websocket"
)

func main() {
Expand Down Expand Up @@ -521,7 +521,7 @@ func main() {

```go
import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v3"
"github.com/valyala/fasthttp"
)

Expand Down Expand Up @@ -562,8 +562,8 @@ func main() {

```go
import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/recover"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/recover"
)

func main() {
Expand All @@ -587,8 +587,8 @@ func main() {

```go
import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/recover"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/recover"
)

func main() {
Expand Down
4 changes: 2 additions & 2 deletions .github/README_es.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Estas pruebas son realizadas por [TechEmpower](https://www.techempower.com/bench

## ⚙️ Instalación

Asegúrese de tener instalado Go ([descargar](https://go.dev/dl/)). Versión `1.17` o superior.
Asegúrese de tener instalado Go ([descargar](https://go.dev/dl/)). Versión `1.20` o superior.

Arranque su proyecto creando una nueva carpeta y ejecutando `go mod init github.com/your/repo` ([mas información](https://go.dev/blog/using-go-modules)) dentro del mismo directorio. Después instale Fiber mediante el comando [`go get`](https://pkg.go.dev/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them):

Expand Down Expand Up @@ -160,7 +160,7 @@ Fiber está **inspirado** en Expressjs, el framework web más popular en Interne

## ⚠️ Limitantes

- Debido a que Fiber utiliza unsafe, la biblioteca no siempre será compatible con la última versión de Go. Fiber 2.40.0 ha sido probado con las versiones de Go 1.17 a 1.21.
- Debido a que Fiber utiliza unsafe, la biblioteca no siempre será compatible con la última versión de Go. Fiber 3.0.0 ha sido probado con las versiones de Go 1.20 a 1.22.
- Fiber no es compatible con interfaces net/http. Esto significa que no lo podrá usar en proyectos como qglgen, go-swagger, u otros que son parte del ecosistema net/http.

## 👀 Ejemplos
Expand Down
8 changes: 4 additions & 4 deletions .github/README_fa.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ func main() {
<br>
<p align="center">
<div dir="rtl">
مطمئن شوید Go را نصب (<a href="https://go.dev/dl/">دانلود</a>) کرده اید. نسخه 1.17 یا بیشتر مورد نیاز است.<br>
مطمئن شوید Go را نصب (<a href="https://go.dev/dl/">دانلود</a>) کرده اید. نسخه 1.20 یا بیشتر مورد نیاز است.<br>
پروژه خود را با ساختن یک پوشه و سپس اجرای <code>go mod init github.com/your/repo</code> داخل پوشه (<a href="https://go.dev/blog/using-go-modules">یادگیری بیشتر</a>) راه اندازی کنید. سپس Fiber را با دستور <code><a href="https://pkg.go.dev/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them">go get</a></code> نصب کنید :
<div dir="rtl">
<br>
Expand Down Expand Up @@ -200,7 +200,7 @@ Fiber از Express <b>الهام گرفته</b>, که محبوب ترین فری

## ⚠️ محدودیت ها

- به دلیل استفاده ناامن از Fiber, ممکن است کتابخانه همیشه با آخرین نسخه Go سازگار نباشد. Fiber 2.40.0 با زبان گو نسخه 1.17 تا 1.21 تست شده است.
- به دلیل استفاده ناامن از Fiber, ممکن است کتابخانه همیشه با آخرین نسخه Go سازگار نباشد. Fiber 3.0.0 با زبان گو نسخه 1.20 تا 1.21 تست شده است.
- فریمورک Fiber با پکیج net/http سازگار نیست. این بدان معناست شما نمی توانید از پکیج های مانند go-swagger, gqlgen یا سایر پروژه هایی که بخشی از اکوسیستم net/http هستند استفاده کنید.

<br>
Expand Down Expand Up @@ -686,8 +686,8 @@ func main() {

```go
import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/recover"
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/recover"
)

func main() {
Expand Down
4 changes: 2 additions & 2 deletions .github/README_fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Ces tests sont effectués par [TechEmpower](https://www.techempower.com/benchmar

## ⚙️ Installation

Make sure you have Go installed ([download](https://go.dev/dl/)). Version `1.17` or higher is required.
Make sure you have Go installed ([download](https://go.dev/dl/)). Version `1.20` or higher is required.

Initialize your project by creating a folder and then running `go mod init github.com/your/repo` ([learn more](https://go.dev/blog/using-go-modules)) inside the folder. Then install Fiber with the [`go get`](https://pkg.go.dev/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them) command:

Expand Down Expand Up @@ -160,7 +160,7 @@ Fiber est **inspiré** par Express, le framework web le plus populaire d'Interne

## ⚠️ Limitations

- Due to Fiber's usage of unsafe, the library may not always be compatible with the latest Go version. Fiber 2.40.0 has been tested with Go versions 1.17 to 1.21.
- Due to Fiber's usage of unsafe, the library may not always be compatible with the latest Go version. Fiber 3.0.0 has been tested with Go versions 1.20 to 1.22.
- Fiber is not compatible with net/http interfaces. This means you will not be able to use projects like gqlgen, go-swagger, or any others which are part of the net/http ecosystem.

## 👀 Exemples
Expand Down
4 changes: 2 additions & 2 deletions .github/README_he.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ func main() {

## ⚙️ התקנה

Make sure you have Go installed ([download](https://go.dev/dl/)). Version `1.17` or higher is required.
Make sure you have Go installed ([download](https://go.dev/dl/)). Version `1.20` or higher is required.

Initialize your project by creating a folder and then running `go mod init github.com/your/repo` ([learn more](https://go.dev/blog/using-go-modules)) inside the folder. Then install Fiber with the [`go get`](https://pkg.go.dev/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them) command:

Expand Down Expand Up @@ -205,7 +205,7 @@ Fiber נוצרה **בהשראת** Express, ה-web framework הפופולרית

## ⚠️ Limitations

- Due to Fiber's usage of unsafe, the library may not always be compatible with the latest Go version. Fiber 2.40.0 has been tested with Go versions 1.17 to 1.21.
- Due to Fiber's usage of unsafe, the library may not always be compatible with the latest Go version. Fiber 3.0.0 has been tested with Go versions 1.20 to 1.22.
- Fiber is not compatible with net/http interfaces. This means you will not be able to use projects like gqlgen, go-swagger, or any others which are part of the net/http ecosystem.

## 👀 דוגמאות
Expand Down
4 changes: 2 additions & 2 deletions .github/README_id.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Pengukuran ini dilakukan oleh [TechEmpower](https://www.techempower.com/benchmar

## ⚙️ Instalasi

Pastikan kamu sudah menginstalasi Golang ([unduh](https://go.dev/dl/)). Dengan versi `1.17` atau lebih tinggi [ Direkomendasikan ].
Pastikan kamu sudah menginstalasi Golang ([unduh](https://go.dev/dl/)). Dengan versi `1.20` atau lebih tinggi [ Direkomendasikan ].

Inisialisasi proyek kamu dengan membuat folder lalu jalankan `go mod init github.com/nama-kamu/repo` ([belajar lebih banyak](https://go.dev/blog/using-go-modules)) di dalam folder. Kemudian instal Fiber dengan perintah [`go get`](https://pkg.go.dev/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them):

Expand Down Expand Up @@ -162,7 +162,7 @@ Kami **mendengarkan** para pengguna di [GitHub Issues](https://github.com/gofibe

## ⚠️ Limitasi

- Karena penggunaan Fiber yang tidak aman, perpustakaan mungkin tidak selalu kompatibel dengan versi Go terbaru. Fiber 2.40.0 telah diuji dengan Go versi 1.17 hingga 1.21.
- Karena penggunaan Fiber yang tidak aman, perpustakaan mungkin tidak selalu kompatibel dengan versi Go terbaru. Fiber 3.0.0 telah diuji dengan Go versi 1.20 hingga 1.22.
- Fiber tidak kompatibel dengan antarmuka net/http. Ini berarti kamu tidak akan dapat menggunakan proyek seperti gqlgen, go-swagger, atau lainnya yang merupakan bagian dari ekosistem net/http.

## 👀 Contoh
Expand Down

0 comments on commit 18f0f87

Please sign in to comment.