Update README.md

3 years ago · e202ebe20a
parent d74e582f87
commit e202ebe20a
1 changed files with 5 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -5,7 +5,11 @@ The tag is split into 2 sections - `above` and `below` the fold.
 Arbitrarily complex Markdown and HTML content is supported in either section. You can even nest multiple collapsibles!

 # Installation
-Copy the `layouts` and `static` folders to your Hugo site root. Ensure that the CSS and JS files are copied over to your output (`public`) folder when rendering. The expectation is that they will be accessible at `<BaseURL>/<ext>/collapse.<ext>`. This can be changed as needed in `collapse.html`.
+Copy the `layouts` and `static` folders to your Hugo site root.
+
+Better yet, use `git submodule add https://github.com/alexandruioanp/hugo-universal-collapsible/` and create the appropriate symlinks. This way it's easy to update.
+
+Ensure that the CSS and JS files are copied over to your output (`public`) folder when rendering. The expectation is that they will be accessible at `<BaseURL>/<ext>/collapse.<ext>`. This can be changed as needed in `collapse.html`.

 If one of the sections (`above`/`below`) contains HTML (e.g. from another shortcode), you might have to enable unsafe rendering in `config.toml` (depending on your Hugo version):