Add scripts to README

Also prep for release
This commit is contained in:
2022-01-06 21:31:36 -05:00
parent 9a9f159cab
commit 86defea3c1
4 changed files with 9 additions and 1 deletions

View File

@@ -2,6 +2,8 @@
This package enables [htmx](https://htmx.org) support within the [Giraffe](https://giraffe.wiki) view engine.
**htmx version: 1.6.1**
### Setup
1. Install the package.
@@ -25,6 +27,8 @@ Support modules include:
- `HxTrigger`
- `HxVals`
There are two `XmlNode`s that will load the htmx script from unpkg; `Htmx.Script.minified` loads the minified version, and `Htmx.Script.unminified` loads the unminified version (useful for debugging).
### Learn
htmx's attributes and these attribute functions map one-to-one. The lone exception is `_hxBoost`, which implies `true`; use `_hxNoBoost` to set it to `false`. The support modules contain named properties for known values (as illustrated with `HxTrigger.Load` above). A few of the modules are more than collections of names, though: