summaryrefslogtreecommitdiffstats
path: root/etc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'etc/README.md')
-rw-r--r--etc/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/etc/README.md b/etc/README.md
new file mode 100644
index 0000000..c93152b
--- /dev/null
+++ b/etc/README.md
@@ -0,0 +1,13 @@
+# HTML templates
+
+This directory contains HTML templates which can be used with the "json" output
+format and a tool that can fill templates with data.
+For example, this can be used with [hdlbr](https://github.com/quitoque/hdlbr)
+to generate nice websites for the reported data.
+
+## Usage with hdlbr
+
+```bash
+repolocli -o json ... > data.json
+hdlbr data.json template.html > output.html
+```