about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
authorMarkus Wüstenberg2023-05-11 10:06:23 +0200
committerMarkus Wüstenberg2023-05-11 10:06:23 +0200
commitc129ae8da154e1f6ef325ac85ca4d2736547c7cd (patch)
tree3b14ce4e547f5195f97f6e12333d5927c9b481f0 /README.md
parentb638b8b078ffedc76513aac30152ce36f2072814 (diff)
downloadgomponents-c129ae8da154e1f6ef325ac85ca4d2736547c7cd.tar.lz
gomponents-c129ae8da154e1f6ef325ac85ca4d2736547c7cd.tar.zst
gomponents-c129ae8da154e1f6ef325ac85ca4d2736547c7cd.zip
Document Text/Textf helpers better
Both in the readme and package doc.

Fixes #133.
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 4 insertions, 2 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),