docs(instructions): add instructions on how to run the scripts #32

AlaskaAirlines · Aug 28, 2023 · 9baa849 · 9baa849
1 parent 57c0a05
commit 9baa849
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/docs/syncAllTemplates.md b/docs/syncAllTemplates.md
@@ -0,0 +1,20 @@
+## How to Run the `syncAllTemplates.mjs` Script
+
+To run the `syncAllTemplates.mjs` script, you will need to add a new node script into the linked component and point that to the `syncAllTemplates.mjs` file. You can individually run the workflow configurations by pointing to the `syncAllTemplates.mjs` file and adding a `--github` parameter after the path. The same can be done for the linter configurations by adding a `--linters` parameter.
+
+### Example Calls
+
+```
+// Default
+./node_modules/@aurodesignsystem/auro-library/scripts/setup/syncAllTemplates.mjs
+```
+
+```
+// Only sync github workflow templates
+./node_modules/@aurodesignsystem/auro-library/scripts/setup/syncAllTemplates.mjs --github
+```
+
+```
+// Only sync linter configuration templates
+./node_modules/@aurodesignsystem/auro-library/scripts/setup/syncAllTemplates.mjs --linters
+```