Update documentation

README.md

@@ -13,7 +13,7 @@ This script has several versions for displaying the result:
 2. Ensure you have installed [node.js](https://nodejs.org/en/).
 3. In terminal, set the repository folder as the directory, e.g: `cd Documents/qlab-display`.
 4. In terminal, enter `npm install` to install all dependencies of the project.
-5. To set variables to allow the scripts to work on your system, open config.json in a text or code editor. Here, you can set:
+5. To set variables to allow the scripts to work on your system, open config.yml in a text or code editor. Here, you can set:
    - Production information:
       - Production name
       - Cue list name

config.yml

@@ -1,24 +1,26 @@
 production:
-  name: Production Name
-  cuelistname: The Cue List
-  version: 1.0.0
+  name: Production Name #                     name of the production, for reference
+  cuelistname: The Cue List #                 name of the cue list you are monitoring, for reference
+  version: 1.0.0 #                            version of config.yml, to keep track of updates
 
-cuelistnumber: CLICKS
+cuelistnumber: CLICKS #                       cue number of the cue list to monitor by osc
 
+# NETWORK AND OSC SETTINGS FOR QLAB
 qlab:
   ip: 127.0.0.1
   port: 53000
   reply: 53001
 
+# NETWORK AND OSC SETTINGS FOR YOUR DISPLAY COMPUTER
 display:
   ip: 127.0.0.1
   openstagecontrol:
     port: 7000
-    number: /next/number
-    name: /next/name
-    heartbeat: /qlab/connected
+    number: /next/number #                    the OSC message to send with the cue number
+    name: /next/name #                        the OSC message to send with the cue name
+    heartbeat: /qlab/connected #              the OSC message to send to indicate Qlab is connected
   streamdeck:
     port: 12321
-    page: 19
-    numberbutton: 15
-    namebutton: 16
+    page: 19 #                                the page on Bitfocus Companion
+    numberbutton: 15 #                        the button on that page to display the cue number
+    namebutton: 16 #                          the button on that page to display the cue name

package.json

@@ -2,7 +2,7 @@
   "name": "qlab-display",
   "bin": "qlab-mon-open-stage-control.js",
   "description": "Monitor the next cue to be triggered from a specific cue list remotely, via osc, with a variety of output options.",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "main": "qlab-mon-open-stage-control.js",
   "scripts": {
     "start": "node .",