From 0f60dd4c4cf9d09b426c3aeb2bbc689164655b2c Mon Sep 17 00:00:00 2001 From: Chrstopher Hunter <8398225+crhntr@users.noreply.github.com> Date: Thu, 23 Jan 2025 23:00:15 -0800 Subject: [PATCH] improve readme intro --- README.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 54a15e4..396ed35 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,10 @@ # Muxt [![Go Reference](https://pkg.go.dev/badge/github.com/crhntr/muxt.svg)](https://pkg.go.dev/github.com/crhntr/muxt) [![Go](https://github.com/crhntr/muxt/actions/workflows/go.yml/badge.svg)](https://github.com/crhntr/muxt/actions/workflows/go.yml) -Since Go 1.22, the standard library route **mu**ltiple**x**er [`*http.ServeMux`](https://pkg.go.dev/net/http#ServeMux) uses http methods, hosts, and path parameters. -Muxt extends this syntax to add method signatures and type static analysis based template type safety tp make it faster to write and test server side rendered hypermedia web applications. - -Muxt generates Go code. It does not require you to add any dependencies outside the Go standard library. - -- It allows you to register HTTP routes from [HTML templates](https://pkg.go.dev/html/template) -- It generates handler functions and registers them on an [`*http.ServeMux`](https://pkg.go.dev/net/http#ServeMux) -- It generates code in handler functions to parse path parameters and form fields -- It generates a receiver interface to represent the boundary between your app code and HTTP/HTML - - Use this to mock out your server and test the view layer of your application +Muxt is a code-generation tool for Go that extends the standard library's recently enhanced (in Go 1.22) [http.ServeMux](https://pkg.go.dev/net/http#ServeMux) (**mu**ltiple**x**er). +It adds a layer of type-safe convenience for writing hypermedia server side rendered (ssr) websites. +It lets you extend HTML templates, close to your user's experience, as your "source of truth" for HTTP routes. +It generates handler functions that renders HTML and parses and map path parameters, form fields, and more. +All this happens with no additional dependencies--just the Go standard library. ### Used By - [portfoliotree.com](https://portfoliotree.com)