diff options
| -rw-r--r-- | README.md | 6 | ||||
| -rw-r--r-- | gomponents.go | 4 |
2 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md index 1ebcd51..bf4a6f6 100644 --- a/README.md +++ b/README.md @@ -25,14 +25,16 @@ Made in 🇩🇰 by [maragu](https://www.maragu.dk), maker of [online Go courses - Auto-completion - Nice formatting with `gofmt` - Simple API that's easy to learn and use (you know most already if you know HTML) +- Useful helpers like `Text` and `Textf` that insert HTML-escaped text, `Map` for mapping data to components, + and `If` for conditional rendering. - No external dependencies ## Usage Get the library using `go get`: -```shell script -go get -u github.com/maragudk/gomponents +```shell +go get github.com/maragudk/gomponents ``` The preferred way to use gomponents is with so-called dot-imports (note the dot before the `gomponents/html` import), diff --git a/gomponents.go b/gomponents.go index 9f86538..7b73a3b 100644 --- a/gomponents.go +++ b/gomponents.go @@ -4,8 +4,8 @@ // to the given writer as a string. // // All DOM elements and attributes can be created by using the El and Attr functions. -// The functions Text, Textf, Raw, and Rawf can be used to create text nodes. -// See also helper functions Group, Map, and If. +// The functions Text, Textf, Raw, and Rawf can be used to create text nodes, either HTML-escaped or unescaped. +// See also helper functions Group, Map, and If for mapping data to Nodes and inserting them conditionally. // // For basic HTML elements and attributes, see the package html. // For higher-level HTML components, see the package components. |