Document the delay option when typing

cfogelklou · Dec 26, 2022 · e692216 · e692216
1 parent b7b7d46
commit e692216
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@ out
 node_modules
 .vscode-test/
 *.vsix
+.dccache
diff --git a/README.md b/README.md
@@ -33,6 +33,8 @@ Note: Any instruction will accept a `"skip": true` settings causing it to be ign
 
 Type some text at the current cursor position of the currently open file. The text setting can either be a string or an array of strings. In the case of an array of strings each string is entered on a new line.
 
+This takes an optional numerical `delay` setting in ms which can be used to override the default delay between keys. This can be useful if you want to speed up or slow down the typing speed for a specific instruction.
+
 Example:
 
 ```JSON
@@ -49,6 +51,8 @@ Example:
 
 Type some text at the current cursor position of the currently open file. The text is read from the file indicated by the path. The path is relative to the `.presentation-buddy` folder.
 
+This takes an optional numerical `delay` setting which can be used to override the default delay between keys. This can be useful if you want to slow down the typing speed for a specific instruction.
+
 Example:
 
 ```JSON
@@ -178,7 +182,8 @@ See `.presentation-buddy\instructions.json`
       "    return x + y;",
       "  }",
       "}"
-    ]
+    ],
+    "delay": 200
   },
   {
     "type": "goto",

diff --git a/examples/init/instructions.json b/examples/init/instructions.json
@@ -13,7 +13,8 @@
       "    return x + y;",
       "  }",
       "}"
-    ]
+    ],
+    "delay": 200
   },
   {
     "type": "goto",
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,7 +13,8 @@ @@
           "    return x + y;",
           "  }",
           "}"
-        ]
+        ],
+        "delay": 200
       },
       {
         "type": "goto",
@@ Expand Down @@