JavaScript readme added.

autumoswitzerland · Nov 8, 2024 · d67a6e0 · d67a6e0
1 parent d6f174c
commit d67a6e0
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/lib/repo/ch/autumo/beetroot/autumo-beetroot/3.1.2/autumo-beetroot-3.1.2.jar b/lib/repo/ch/autumo/beetroot/autumo-beetroot/3.1.2/autumo-beetroot-3.1.2.jar
diff --git a/web/js/readme.js b/web/js/readme.js
@@ -0,0 +1,16 @@
+/**
+ *
+ * If your Java Script file name ends with 'search.js', you can use the
+ * beetRoot variable '{$servletName}'.
+ * 
+ * Example:
+ * 
+ * - Script : 'livesearch.js' or 'tasks-search.js'
+ * - Code   : let fetchUrl = 
+ *     `{$servletName}/tasks/livesearch?q=${encodeURIComponent(query)}`;
+ *
+ * The variable '{$servletName}' is either replaced by the servlet name 
+ * or by an empty character string if the beetRoot standalone server is 
+ * used.
+ * 
+ */