From 3c656160f5efaef301eb4fc7937ae5de94d4921b Mon Sep 17 00:00:00 2001
From: Eltrac <hi@guhub.cn>
Date: Thu, 27 Nov 2025 11:57:23 +0800
Subject: docs: add README

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f4c7dc1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Growel
+
+**Minimal, headless, zero-dependency Web framework written in Go.** This is toy software I develop to learn, so do not use in production.
+
+## Usage
+
+```go
+api := growel.New()
+
+api.GET("/hello", func(c *growel.Context) {
+	c.JSON(200, map[string]string{
+		"message": "Hello, Growel!"
+	})
+})
+
+api.GET("/user/", func(c *growel.Context) {
+	c.JSON(200, Users)
+})
+
+api.GET("/user/:uid", func(c *growel.Context) {
+	uid, err := strconv.Atoi(c.Params["uid"])
+	if err != nil {
+		c.BadRequest("Invalid user ID")
+		return
+	}
+
+	for _, user := range Users {
+		if user.ID == uid {
+			c.JSON(200, user)
+			return
+		}
+	}
+
+	c.NotFound("User not found")
+})
+```
+
+## License
+
+MIT
-- 
cgit v1.2.3