diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md index 5d15060..cd18771 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,36 @@ without the use of a template language. Think server-side-rendered React, but without the virtual DOM and diffing. The implementation is still incomplete, but usable. The API may change until version 1 is reached. + +## Usage + +Get the library using `go get`: + +```shell script +go get -u github.com/maragudk/gomponents +``` + +Then do something like this: + +```go +package foo + +import ( + "net/http" + + g "github.com/maragudk/gomponents" + "github.com/maragudk/gomponents/el" +) + +func main() { + _ = http.ListenAndServe("localhost:8080", handler()) +} + +func handler() http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + _ = g.Write(w, el.Document(el.HTML(el.Head(el.Title("Hi!")), el.Body(el.H1("Hi!"))))) + } +} +``` + +For more complete examples, see [the examples directory](examples/). |