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