docs: remove usage of WithPort from docs in favor of WithAddr

go-fuego · Apr 5, 2024 · 4997557 · 4997557
1 parent 7197cba
commit 4997557
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/documentation/docs/guides/options.md b/documentation/docs/guides/options.md
@@ -11,7 +11,7 @@ import "github.com/go-fuego/fuego"
 
 func main() {
 	s := fuego.NewServer(
-		fuego.WithPort(8080),
+		fuego.WithAddr("localhost:8080"),
 		fuego.WithOpenAPIConfig(fuego.OpenAPIConfig{
 			DisableSwagger   : true,
 		}),
@@ -27,7 +27,19 @@ func main() {
 
 ## Some options
 
-### Port
+### Address
+
+You can change the address of the server with the `WithAddr` option.
+
+```go
+s := fuego.NewServer(
+	fuego.WithAddr("localhost:8080"),
+)
+```
+
+### Port (Deprecated)
+
+**Deprecated** in favor of `WithAddr` shown above.
 
 You can change the port of the server with the `WithPort` option.
 

diff --git a/examples/full-app-gourmet/main.go b/examples/full-app-gourmet/main.go
@@ -2,6 +2,7 @@ package main
 
 import (
 	"flag"
+	"fmt"
 	"log/slog"
 	"os"
 
@@ -69,7 +70,7 @@ func main() {
 		Views: viewsRessources,
 	}
 
-	app := rs.Setup(fuego.WithPort(*port))
+	app := rs.Setup(fuego.WithAddr(fmt.Sprintf("localhost:%d", *port)))
 
 	// Run the server!
 	err = app.Run()