From 91cf4f4d433e7b42936dd110293b47c24aaab665 Mon Sep 17 00:00:00 2001
From: maddalax <jm@madev.me>
Date: Fri, 20 Sep 2024 13:40:38 -0500
Subject: [PATCH 1/4] Update README.md

---
 README.md | 37 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 36 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 87cbb08..2707435 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,36 @@
-WIP, do not use at the moment.
+**This is a prerelease version and generally should not be used at this time. Watch on github for the stable release!**
+
+## **htmgo**
+
+### build simple and scalable systems with go + htmx
+
+-------
+
+
+
+**introduction:**
+
+htmgo is a lightweight pure go way to build interactive websites / web applications using go & htmx.
+
+By combining the speed & simplicity of go + hypermedia attributes ([htmx](https://htmx.org)) to add interactivity to websites, all conveniently wrapped in pure go, you can build simple, fast, interactive websites without touching javascript. All compiled to a **single deployable binary**.
+
+```go
+func IndexPage(ctx *h.RequestContext) *h.Page {
+  now := time.Now()
+  return h.NewPage(
+    h.Div(
+      h.Class("flex gap-2"),
+      h.TextF("the current time is %s", now.String())
+    )
+  )
+}
+```
+
+**core features:**
+
+1. deployable single binary
+2. live reload (rebuilds css, go, ent schema, and routes upon change)
+3. automatic page and partial registration based on file path
+4. built in tailwindcss support, no need to configure anything by default
+5. plugin architecture to include optional plugins to streamline development, such as http://entgo.io
+6. custom [htmx extensions](https://github.com/maddalax/htmgo/tree/b610aefa36e648b98a13823a6f8d87566120cfcc/framework/assets/js/htmxextensions) to reduce boilerplate with common tasks

From e98d6b0993f524e93012420a34a8179533efa15f Mon Sep 17 00:00:00 2001
From: maddalax <jm@madev.me>
Date: Fri, 20 Sep 2024 13:42:35 -0500
Subject: [PATCH 2/4] Update README.md

---
 README.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2707435..de299db 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
-**This is a prerelease version and generally should not be used at this time. Watch on github for the stable release!**
+[!WARNING]
+This is a prerelease version and generally should not be used at this time. Watch on github for the stable release!
 
 ## **htmgo**
 

From 403e730a42cfa40348ab8b8cc183d7b01fe8d38f Mon Sep 17 00:00:00 2001
From: maddalax <jm@madev.me>
Date: Fri, 20 Sep 2024 13:43:31 -0500
Subject: [PATCH 3/4] Update README.md

---
 README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index de299db..78ccfda 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-[!WARNING]
-This is a prerelease version and generally should not be used at this time. Watch on github for the stable release!
+> [!WARNING]
+> This is a prerelease version and generally should not be used at this time. Watch on github for the stable release!
 
 ## **htmgo**
 

From aa40eac72a5e2af96382a122657ef716796a86a1 Mon Sep 17 00:00:00 2001
From: maddalax <jm@madev.me>
Date: Fri, 20 Sep 2024 13:46:31 -0500
Subject: [PATCH 4/4] Update README.md

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 78ccfda..21540c7 100644
--- a/README.md
+++ b/README.md
@@ -35,3 +35,9 @@ func IndexPage(ctx *h.RequestContext) *h.Page {
 4. built in tailwindcss support, no need to configure anything by default
 5. plugin architecture to include optional plugins to streamline development, such as http://entgo.io
 6. custom [htmx extensions](https://github.com/maddalax/htmgo/tree/b610aefa36e648b98a13823a6f8d87566120cfcc/framework/assets/js/htmxextensions) to reduce boilerplate with common tasks
+
+**get started:**
+> [!WARNING]
+> This is a prerelease version and generally should not be used at this time. Watch on github for the stable release!
+
+View documentation on [htmgo.dev](https://htmgo.dev/).