added docs

querytechnology · Apr 23, 2019 · 122191f · 122191f
1 parent ddd9210
commit 122191f
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,32 @@
 # tqc-php
 Command line interface in php for TinyQueries compiler
+
+## Example config file
+
+The folder from which the script is run should contain a file `tinyqueries.json`
+
+```json
+{
+	"project": {
+		"label": "my-project-label"
+	},
+	"compiler": {
+		"version": "v3.9.0",
+		"apiKey": "1234567890",
+		"input": "<input folder>",
+		"output": "<output folder>"
+	}
+}
+```
+
+## Optional settings
+
+### compiler.outputFieldNames
+
+```json
+{
+    "compiler": {
+        "outputFieldNames": "full|last-part-only"
+    }
+}
+```