docs: update sample document

Author: thuongtruong109

README.md

@@ -139,7 +139,13 @@
 ## 📦 Installation
 
 ```go
-go get github.com/thuongtruong109/gouse
+go get -u github.com/thuongtruong109/gouse
+```
+
+or add to your `go.mod` file:
+
+```go
+required github.com/thuongtruong109/gouse
 ```
 
 ## 🕯️ Quick Start
@@ -186,7 +192,7 @@ func main() {
 
 `INPUT`: 1000000
 
-<!-- ## 📚 Examples -->
+# ![Benchmark](/public/benchmark.png)
 
 ## 📁 Project Structure
 
@@ -202,7 +208,11 @@ $ git clone https://github.com/thuongtruong109/gouse.git
 
 ## 📝 Contributing
 
-- We welcome your contributions! If you're looking for issues to work on, try looking at the good first issue list. We do our best to tag issues suitable for new external contributors with that label, so it's a great way to find something you can help with!
+Gouse is an open source project and built on the top of other open-source projects. Welcome all the kinds of contributions. No matter it is for typo fix, bug fix or big new features. Please do not hesitate to ask a question or send a pull request.
+
+We strongly value documentation and integration with other projects, so we are very glad to accept improvements for these aspects.
+
+If you're looking for issues to work on, try looking at the good first issue list. We do our best to tag issues suitable for new external contributors with that label, so it's a great way to find something you can help with!
 
 - Please read our [`Code of Conduct`](.github/CODE_OF_CONDUCT.md) before contributing.
 

api.go

@@ -137,7 +137,7 @@ type IHeader struct {
 }
 
 func Header(w http.ResponseWriter, r *http.Request) {
-	w.Header().Set("Content-Type", "application/json")
+	setJSONHeader(w)
 
 	for k, v := range r.Header {
 		fmt.Fprintf(w, "%q: %q\n\n", k, v)
@@ -153,6 +153,7 @@ func Header(w http.ResponseWriter, r *http.Request) {
 		ContentLength: 200,
 		ContentType:   "application/json",
 	}
+	w.WriteHeader(200)
 	json.NewEncoder(w).Encode(p)
 }
 

docs/docs/introduction/about.md

@@ -4,6 +4,10 @@
 
 ![Project Structure](https://raw.githubusercontent.com/thuongtruong109/gouse/diagram/project-structure.svg)
 
+## 📊 Benchmark
+
+![Benchmark](https://github.com/thuongtruong109/gouse/blob/main/public/benchmark.png)
+
 ## 📜 Changelog
 
 - Gouse is under active development. This means that new features, bug fixes, and breaking changes will be released frequently. We encourage you to keep the [`CHANGELOG`](https://github.com/thuongtruong109/gouse/blob/main/CHANGELOG.md) open while upgrading to see what's new!
@@ -36,3 +40,15 @@
   - [Cache for Go](github.com/patrickmn/go-cache) - An in-memory key:value store/cache (similar to Memcached) library for Go 🗄
   - [Toml Go](github.com/pelletier/go-toml) - A Go library for managing configuration data from files 📄
   - [Yaml](gopkg.in/yaml.v2) - A YAML support for the Go language 📄
+
+## 🧑‍🤝‍🧑 Contributing
+
+Gouse is an open source project and built on the top of other open-source projects. Welcome all the kinds of contributions. No matter it is for typo fix, bug fix or big new features. Please do not hesitate to ask a question or send a pull request.
+
+We strongly value documentation and integration with other projects, so we are very glad to accept improvements for these aspects.
+
+If you're looking for issues to work on, try looking at the good first issue list. We do our best to tag issues suitable for new external contributors with that label, so it's a great way to find something you can help with!
+
+- Please read our [`Code of Conduct`](https://github.com/thuongtruong109/gouse/blob/main/.github/CODE_OF_CONDUCT.md) before contributing.
+
+- Refer to the [`Contributing Guide`](https://github.com/thuongtruong109/gouse/blob/main/.github/CONTRIBUTING.md) for more information on how to get started.

docs/docs/introduction/getting-started.md

@@ -8,6 +8,12 @@
 go get github.com/thuongtruong109/gouse
 ```
 
+or add to your `go.mod` file:
+
+```go
+required github.com/thuongtruong109/gouse
+```
+
 ## 🕯️ Quick Start
 
 ```go
@@ -38,4 +44,4 @@ func main() {
 }
 ```
 
-- Please refer to the [`receipts`](/receipts/array) for more examples.
+- Please refer to the [`receipts`](/receipts/array) for more examples.

docs/docs/receipts/api.md

@@ -4,74 +4,104 @@
 
 ```go
 import (
+	"context"
+	"fmt"
 	"net/http"
-	"time"
 	"github.com/thuongtruong109/gouse"
 )
 ```
 
-## 1. Loadbalancer
+## 1. Validate
 
-Description: Load balancer with health check<br>Input params: (ILbConf.ProxyPort, ILbConf.Backends)<br>
+Description: Validate request data<br>Input params: (ctxBind func() error, ctxReq func() context.Context, req any)<br>
 
 ```go
-func Loadbalancer() {
-	lbCfg := gouse.ILbConf{
-		ProxyPort: "8080",
-		Backends: []gouse.ILb{
-			{
-				URL:    "http://localhost:8081",
-				IsDead: false,
-			},
-			{
-				URL:    "http://localhost:8082",
-				IsDead: false,
-			},
-			{
-				URL:    "http://localhost:8083",
-				IsDead: false,
-			},
-		},
+func Validate() {
+	type UserRequest struct {
+		Name  string `json:"name" validate:"required"`
+		Email string `json:"email" validate:"required,email"`
 	}
 
-	// gouse.HealthCheck() // Enable health check (optional)
-	gouse.LoadBalancer(lbCfg.ProxyPort, lbCfg.Backends)
+	req := UserRequest{
+		Name:  "John",
+		Email: "invalid-email",
+	}
+
+	ctxBind := func() error {
+		return nil
+	}
+
+	ctxReq := func() context.Context {
+		return context.Background()
+	}
+
+	err := gouse.Validate(ctxBind, ctxReq, req)
+	if err != nil {
+		gouse.Println("Validation failed:", err)
+	} else {
+		gouse.Println("Validation succeeded!")
+	}
 }
 ```
 
-## 2. Server
+## 2. Upload file
 
-Description: Start server with graceful shutdown mode for API<br>Input params: (gouse.IServer)<br>
+Description: Upload file to server<br>Input params: (servePath, storagePath string)<br>
 
 ```go
-func Server() {
-	gs := gouse.IServer{
-		Port:          "3000",
-		StartMsg:      "Starting server at port http://localhost:3000",
-		ShutdownMsg:   "Shutting down server...",
-		SleepTimeout:  5 * time.Second,
-		HeaderTimeout: 5 * time.Second,
-	}
+func UploadFile() {
+	http.HandleFunc("/upload-single", func(w http.ResponseWriter, r *http.Request) {
+		gouse.UploadSingle(w, r, "http://localhost:8080/img", "./public")
+	})
+	http.HandleFunc("/upload-multi", func(w http.ResponseWriter, r *http.Request) {
+		gouse.UploadMulti(w, r, "http://localhost:8080/img", "./public")
+	})
 
-	gs.Server()
+	http.ListenAndServe(":8080", nil)
 }
 ```
 
-## 3. Upload file
+## 3. Header
 
-Description: Upload file to server<br>Input params: (servePath, storagePath string)<br>
+Description: Return the header of the request<br>Input params: (w http.ResponseWriter, r *http.Request)<br>
 
 ```go
-func UploadFile() {
-	{
-		http.HandleFunc("/upload-single", func(w http.ResponseWriter, r *http.Request) {
-			gouse.UploadSingle(w, r, "http://localhost:8080/img", "./public")
-		})
-		http.HandleFunc("/upload-multi", func(w http.ResponseWriter, r *http.Request) {
-			gouse.UploadMulti(w, r, "http://localhost:8080/img", "./public")
-		})
-
-		http.ListenAndServe(":8080", nil)
+func Header() {
+	http.HandleFunc("/header", gouse.Header)
+
+	fmt.Println("Server is running on http://localhost:8080")
+	if err := http.ListenAndServe(":8080", nil); err != nil {
+		fmt.Println("Server failed to start:", err)
 	}
 }
 ```
+
+## 4. Pagination
+
+Description: Setup pagination<br>Input params: (page, size int)<br>
+
+```go
+func Pagination() {
+	pagination := gouse.NewPagination(10, 1)
+
+	pagination.SetPage("2")
+	pagination.SetSize("15")
+	pagination.SetOrderBy("desc")
+
+	pagination.Total = 100
+
+	fmt.Println("Pagination Info:")
+	fmt.Println("Page:", pagination.GetPage())
+	fmt.Println("Size per Page:", pagination.GetSize())
+	fmt.Println("Order By:", pagination.GetOrderBy())
+	fmt.Println("Total Pages:", pagination.GetTotalPages())
+	fmt.Println("Next Page:", pagination.GetNextPage())
+	fmt.Println("Prev Page:", pagination.GetPrevPage())
+	fmt.Println("Has More Pages:", pagination.GetHasMore(pagination.Total))
+	fmt.Println("Offset:", pagination.GetOffset())
+	fmt.Println("First Page:", pagination.GetFirstPage())
+	fmt.Println("Last Page:", pagination.GetLastPage())
+	fmt.Println("Total Items:", pagination.Total)
+	fmt.Println("Query String:", pagination.GetQueryString())
+}
+```

docs/docs/receipts/color.md

@@ -0,0 +1,93 @@
+
+# <Badge style='font-size: 1.8rem; text-shadow: 1px 1px 2px rgba(0, 0, 0, 0.3); padding: 0.35rem 0.75rem 0.35rem 0;' type='info' text='🔖 Color' />
+
+
+```go
+import (
+	"fmt"
+	"github.com/thuongtruong109/gouse"
+)
+```
+
+## 1. Color hue to rgb
+
+Description: Convert color from Hue to RGB format<br>Parameters: (p, q, t float64) float64 -> float64<br>
+
+```go
+func ColorHueToRgb() {
+	p := 0.2
+	q := 0.8
+	t := 120.0
+
+	rgb := gouse.Hue2Rgb(p, q, t)
+
+	fmt.Printf("RGB value for Hue2Rgb(%f, %f, %f) = %f\n", p, q, t, rgb)
+}
+```
+
+## 2. Color hlsa to rgba
+
+Description: Convert color from HLSA to RGBA format<br>Parameters: (h, l, s, a float64) color.RGBA -> color.RGBA<br>
+
+```go
+func ColorHlsaToRgba() {
+	h := 120.0 // Hue: 120° (green)
+	l := 0.5   // Lightness: 50%
+	s := 0.75  // Saturation: 75%
+	a := 1.0   // Alpha: fully opaque (100%)
+
+	rgba := gouse.Hlsa2Rgba(h, l, s, a)
+
+	fmt.Printf("HLSA(%f, %f, %f, %f) = RGBA(%d, %d, %d, %d)\n", h, l, s, a, rgba.R, rgba.G, rgba.B, rgba.A)
+}
+```
+
+## 3. Color rgba to hlsa
+
+Description: Convert color from RGBA to HLSA format<br>Parameters: (r, g, b, a uint8) -> (float64, float64, float64, float64)<br>
+
+```go
+func ColorRgbaToHlsa() {
+	r, g, b, a := uint8(255), uint8(0), uint8(0), uint8(128) // Red with 50% opacity
+
+	h, s, l, af := gouse.Rgba2Hlsa(r, g, b, a)
+
+	fmt.Printf("RGBA(%d, %d, %d, %d) => HLSA: %.2f, %.2f, %.2f, %.2f\n", r, g, b, a, h, s, l, af)
+}
+```
+
+## 4. Color hex to hlsa
+
+Description: Convert color from Hex to HLSA format<br>Parameters: (hex string) -> (float64, float64, float64, float64, error)<br>
+
+```go
+func ColorHexToHlsa() {
+	hex := "#FF5733CC" // RGBA: Red=255, Green=87, Blue=51, Alpha=204 (opaque)
+
+	h, s, l, a, err := gouse.Hex2Hlsa(hex)
+	if err != nil {
+		fmt.Println("Error:", err)
+		return
+	}
+
+	fmt.Printf("Hex: %s => HLSA: %.2f, %.2f, %.2f, %.2f\n", hex, h, s, l, a)
+}
+```
+
+## 5. Color hex to rgba
+
+Description: Convert color from Hex to RGBA format<br>Parameters: (hex string) -> (color.RGBA, error)<br>
+
+```go
+func ColorHexToRgba() {
+	hex := "#FF5733" // RGB: Red=255, Green=87, Blue=51
+
+	rgba, err := gouse.Hex2Rgba(hex)
+	if err != nil {
+		fmt.Println("Error:", err)
+		return
+	}
+
+	fmt.Printf("Hex: %s => RGBA: %d, %d, %d, %d\n", hex, rgba.R, rgba.G, rgba.B, rgba.A)
+}
+```

docs/docs/receipts/context.md

@@ -0,0 +1,48 @@
+
+# <Badge style='font-size: 1.8rem; text-shadow: 1px 1px 2px rgba(0, 0, 0, 0.3); padding: 0.35rem 0.75rem 0.35rem 0;' type='info' text='🔖 Context' />
+
+
+```go
+import (
+	"fmt"
+	"time"
+	"github.com/thuongtruong109/gouse"
+)
+```
+
+## 1. Context
+
+Description: Management of context and cancellation in Go.<br>
+
+```go
+func Context() {
+	ctx, cancel := gouse.CtxCancel()
+	gouse.SetCtx(ctx)
+
+	go func() {
+		for {
+			select {
+			case <-ctx.Done():
+				fmt.Println("Process cancelled.")
+				return
+			default:
+				// Simulate some work
+				fmt.Println("Working...")
+				time.Sleep(1 * time.Second)
+			}
+		}
+	}()
+
+	// Simulating program running and waiting for termination signal
+	time.Sleep(5 * time.Second)
+
+	// After 5 seconds, trigger cancellation
+	cancel()
+
+	// Wait for the program to exit
+	time.Sleep(2 * time.Second)
+
+	// Retrieve the context and print if it's cancelled
+	fmt.Println("Is context cancelled?", gouse.GetCtx().Done() != nil)
+}
+```