From 7c384186aa78457f32f4434220513fc94e8520e2 Mon Sep 17 00:00:00 2001
From: Seth Hoenig <shoenig@duck.com>
Date: Wed, 18 Dec 2024 05:33:58 -0600
Subject: [PATCH] repo: update readme with example

---
 README.md     | 32 ++++++++++++++++++++++++++++++++
 forms.go      |  4 ++--
 forms_test.go |  2 +-
 go.mod        |  2 +-
 4 files changed, 36 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 3cb6542..ad39ca6 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,38 @@ The `forms` package can be added to a project by running:
 go get cattlecloud.net/go/forms@latest
 ```
 
+```go
+import "cattlecloud.net/go/forms"
+```
+
+### Examples
+
+##### parsing http request
+
+```go
+var (
+  name string
+  age  int
+)
+
+err := forms.Parse(request, forms.Schema{
+  "NAME": forms.String(&name),
+  "AGE":  forms.Int(&age),
+})
+```
+
+##### about requests
+
+Typically the HTTP request will be given to you in the form of an http handler,
+e.g.
+
+```go
+func(w http.ResponseWriter, r *http.Request) {
+  _ = r.ParseForm()
+  // now r form data is available to parse
+}
+```
+
 ### License
 
 The `cattlecloud.net/go/forms` module is open source under the [BSD](LICENSE) license.
diff --git a/forms.go b/forms.go
index fd60efa..177ec0d 100644
--- a/forms.go
+++ b/forms.go
@@ -1,9 +1,9 @@
 // Copyright (c) CattleCloud LLC
 // SPDX-License-Identifier: BSD-3-Clause
 
-// Package formdata provides a way to safely and conveniently extract html Form
+// Package forms provides a way to safely and conveniently extract html Form
 // data using a definied schema.
-package formdata
+package forms
 
 import (
 	"errors"
diff --git a/forms_test.go b/forms_test.go
index d105ae3..43ac87a 100644
--- a/forms_test.go
+++ b/forms_test.go
@@ -1,7 +1,7 @@
 // Copyright (c) CattleCloud LLC
 // SPDX-License-Identifier: BSD-3-Clause
 
-package formdata
+package forms
 
 import (
 	"context"
diff --git a/go.mod b/go.mod
index 6955b78..fe49081 100644
--- a/go.mod
+++ b/go.mod
@@ -1,6 +1,6 @@
 module cattlecloud.net/go/forms
 
-go 1.23.4
+go 1.23
 
 require (
 	github.com/shoenig/go-conceal v0.5.4