about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorMarkus Wüstenberg2024-09-19 21:49:20 +0200
committerMarkus Wüstenberg2024-09-19 21:49:20 +0200
commit5d8f397545b32df223ef6c060128bb4e35963c50 (patch)
tree407d54133f0436bd7067327081cd257206c34db6
parent12acb8041060306b361109b46f9f05dbb4382ea0 (diff)
downloadgomponents-5d8f397545b32df223ef6c060128bb4e35963c50.tar.lz
gomponents-5d8f397545b32df223ef6c060128bb4e35963c50.tar.zst
gomponents-5d8f397545b32df223ef6c060128bb4e35963c50.zip
Reword readme slightly
-rw-r--r--README.md20
1 files changed, 13 insertions, 7 deletions
diff --git a/README.md b/README.md
index 1650ba4..d5fe7cb 100644
--- a/README.md
+++ b/README.md
@@ -22,13 +22,17 @@ Made in 🇩🇰 by [maragu](https://www.maragu.dk), maker of [online Go courses
 ## Features
 
 - Build reusable HTML components
-- Write declarative HTML5 in Go without all the strings, so you get
-  - Type safety
-  - Auto-completion
-  - Nice formatting with `gofmt`
+- Write declarative HTML 5 in Go without all the strings, so you get
+  - Type safety from the compiler
+  - Auto-completion from the IDE
+  - Easy debugging with the standard Go debugger
+  - Automatic formatting with `gofmt`/`goimports`
 - 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`/`Iff` for conditional rendering.
+- Useful helpers like
+  - `Text` and `Textf` that insert HTML-escaped text,
+  - `Raw` and `Rawf` for inserting raw strings,
+  - `Map` for mapping data to components and `Group` for grouping components,
+  - and `If`/`Iff` for conditional rendering.
 - No external dependencies
 
 ## Usage
@@ -71,7 +75,9 @@ For a more complete example, see [the examples directory](internal/examples/).
 ### What's up with the specially named elements and attributes?
 
 Unfortunately, there are six main name clashes in HTML elements and attributes, so they need an `El` or `Attr` suffix,
-to be able to co-exist in the same package in Go. I've chosen one or the other based on what I think is the common usage.
+to be able to co-exist in the same package in Go.
+
+I've chosen one or the other based on what I think is the common usage.
 In either case, the less-used variant also exists in the codebase:
 
 - `cite` (`Cite`/`CiteAttr`, `CiteEl` also exists)