docs: add read me

README.md

@@ -0,0 +1,103 @@
+![Go](https://img.shields.io/badge/go-%2300ADD8.svg?style=for-the-badge&logo=go&logoColor=white)
+
+# Param Decoder
+
+This lib is built to get request query params and deserialize in structs in the easiest way.
+
+## How to install
+
+Add at your project with the command
+
+```
+go get github.com/marcoscouto/param-decoder
+```
+
+## How to use
+
+To use the lib you need to create a struct with public attributes and with the supported types.
+
+```
+type Params struct {
+	ID        string    `query:"id"`
+	Name      string    `query:"name"`
+	CreatedAt time.Time `query:"created_at"`
+	Age       int32     `query:"age"`
+	Balance   float32   `query:"balance"`
+	Verified  bool      `query:"verified"`
+}
+```
+
+Import in the file that will use
+
+```
+decoder "github.com/marcoscouto/param-decoder"
+```
+
+Call the method and insert the struct type in generics field.
+
+```
+params := decoder.DecodeQueryParams[Params](r.URL.Query())
+```
+
+The method will return a `Params` struct with the values from query. If the value is empty in query parameter, the struct will return the default value of type.
+
+## Supported types
+
+- string
+- bool
+- time.Time
+- int
+`int, int8, int16, int32, int64`
+- uint
+`uint, uint8, uint16, uint32, uint64`
+- float
+`float32, float64`
+
+
+
+## Full Example
+
+main.go
+
+```
+package main
+
+import (
+	"encoding/json"
+	"net/http"
+	"time"
+
+	"github.com/gorilla/mux"
+	decoder "github.com/marcoscouto/param-decoder"
+)
+
+const (
+	ContentType     = "Content-Type"
+	ApplicationJson = "application/json"
+)
+
+func main() {
+	r := mux.NewRouter()
+	r.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
+		params := decoder.DecodeQueryParams[Params](r.URL.Query())
+		marshal, _ := json.Marshal(params)
+		w.Header().Set(ContentType, ApplicationJson)
+		w.Write(marshal)
+	})
+	http.ListenAndServe(":3000", r)
+}
+
+type Params struct {
+	ID        string    `query:"id"`
+	Name      string    `query:"name"`
+	CreatedAt time.Time `query:"created_at"`
+	Age       int32     `query:"age"`
+	Balance   float32   `query:"balance"`
+	Verified  bool      `query:"verified"`
+}
+```
+
+cURL
+```
+curl --location 'http://localhost:3000?name=some_name&id=some_id&age=99&created_at=2024-01-05T12%3A13%3A14Z&balance=10.11&verified=true'
+```