Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/gohugoio/hugo-mod-jslibs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2020-08-22 18:56:40 +0300
committerGitHub <noreply@github.com>2020-08-22 18:56:40 +0300
commitcaa7a63fa6f731c093ba3cab48734023810a86f3 (patch)
tree5de0b3de33daba4e034103381e047a38d6254543
parent2b339bc1e3f3fe2227e095a8cf68c418b131cae0 (diff)
Update README.md
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index 34e1f05..862cb68 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,22 @@
# Hugo JS Libraries
-A small collection of JS libraries that works well with Hugo, packaged and ready for use as Hugo Modules.
+A small collection of JS libraries that works well with Hugo, packaged and ready for use as Hugo Modules.
+
+Hugo has great support for [JavaScript building](https://gohugo.io/hugo-pipes/js/), but these libraries stand solid on their own and you don't need `npm` to use them. It's similar to including the libraries from CDN, but you get the added benefit of:
+
+* Offline use.
+* They are aware of the Hugo life cycle (minify, fingerprint, add integrity hash only when in production).
+* The dependencies can be vendored (`hugo mod vendor`) to make your site truly standalone.
+* ...
+
+To use AlpineJS with Turbolinks you can just import the modules into your config and then add this to youer `head`
+
+```
+{{ partialCached "jslibs/alpinejs/script-src.html" "-" }}
+{{ partialCached "jslibs/turbolinks/script-src.html" "-" }}
+```
See each component's README for usage. The Hugo documentation has more information about [Hugo Modules](https://gohugo.io/hugo-modules/).
+
+## Versioning
+