summaryrefslogtreecommitdiff
path: root/packages/fcl-mustache/examples/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'packages/fcl-mustache/examples/README.txt')
-rw-r--r--packages/fcl-mustache/examples/README.txt27
1 files changed, 27 insertions, 0 deletions
diff --git a/packages/fcl-mustache/examples/README.txt b/packages/fcl-mustache/examples/README.txt
new file mode 100644
index 0000000000..b46598b216
--- /dev/null
+++ b/packages/fcl-mustache/examples/README.txt
@@ -0,0 +1,27 @@
+demo1 sample program:
+
+Demonstrates the most basic use of the mustache parser
+
+demo2 sample program:
+
+Demonstrates the use of the mustache parser with a CSV dataset
+
+
+mustache example program:
+
+Can be used to load a template and data, and process the result.
+Output to standard output or file.
+The template and JSON value can be loaded from file (using @filename),
+or their value can be specified directly on the command-line.
+
+Example usage:
+
+Load template from family.tmpl file, data from family.json file:
+
+./mustache -d title="my family" -t @family.tmpl -j @family.json
+
+Load template from family.tmpl file, data from family.csv file:
+
+./mustache -d title="my family" -t @family.tmpl -c family.csv
+
+Use of expressions can be enabled with the -e switch.