diff options
| author | Markus Wüstenberg | 2020-11-02 11:05:23 +0100 |
|---|---|---|
| committer | GitHub | 2020-11-02 11:05:23 +0100 |
| commit | 87d09c382434c9198c50356954fedf0ab8e5576f (patch) | |
| tree | c544cb808bec3bd119626c192dcc125741292aad | |
| parent | 267d40bbea6036f913c4047a6a2055b3e5d7bb96 (diff) | |
| download | gomponents-87d09c382434c9198c50356954fedf0ab8e5576f.tar.lz gomponents-87d09c382434c9198c50356954fedf0ab8e5576f.tar.zst gomponents-87d09c382434c9198c50356954fedf0ab8e5576f.zip | |
Add package docs (#41)
Also update readme with features.
| -rw-r--r-- | README.md | 10 | ||||
| -rw-r--r-- | assert/assert.go | 1 | ||||
| -rw-r--r-- | components/documents.go | 1 |
3 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md index 28f1edf..118a1c7 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,16 @@ The implementation is still incomplete, but usable. The API may change until ver Check out the blog post [gomponents: declarative view components in Go](https://www.maragu.dk/blog/gomponents-declarative-view-components-in-go/) for background. +## Features + +- Write declarative HTML in Go without all the strings, so you get + - Type safety + - Auto-completion + - Nice formatting with `gofmt` +- Simple API that's easy to learn and use +- Build reusable view components +- No external dependencies + ## Usage Get the library using `go get`: diff --git a/assert/assert.go b/assert/assert.go index b18ff65..deeb3e9 100644 --- a/assert/assert.go +++ b/assert/assert.go @@ -1,3 +1,4 @@ +// Package assert provides testing helpers. package assert import ( diff --git a/components/documents.go b/components/documents.go index 65f3e63..5e96466 100644 --- a/components/documents.go +++ b/components/documents.go @@ -1,3 +1,4 @@ +// Package components provides high-level components that are composed of low-level elements and attributes. package components import ( |