From df11b23af9a8263237faa098cd4c59195ebbcdb1 Mon Sep 17 00:00:00 2001
From: Matt Magoffin <matt@solarnetwork.net>
Date: Tue, 2 Jul 2024 08:08:18 +1200
Subject: [PATCH] Ignore local_* files to allow for customized startup scripts.

---
 .gitignore | 3 +++
 README.md  | 9 +++++++++
 2 files changed, 12 insertions(+)

diff --git a/.gitignore b/.gitignore
index c6bba59..43ab82b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -128,3 +128,6 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+# local scripts
+local_*
diff --git a/README.md b/README.md
index a3cce0b..0e0cd2e 100644
--- a/README.md
+++ b/README.md
@@ -60,6 +60,15 @@ npx ts-node index_201.ts
 2023-03-27 13:10:17 info: Receive message ⬅️  [3,"79a41b2e-2c4a-4a65-9d7e-417967a8f95f",{"currentTime":"2023-03-27T11:10:17.955Z"}]
 ```
 
+## Custom VCP scripts
+
+If you would like to customize the VCP startup script, any file whose name starts with `local_` will be ignored by git,
+so you can write a custom VCP script like `local_16.ts` and then run it like
+
+```bash
+WS_URL=ws://localhost:3000 CP_ID=vcp_16_test npx ts-node local_16.ts
+```
+
 ## Executing Admin Commands
 
 Some messages are automatically sent by the VCP, for example, `BootNotification` or `StartTransaction` and `StopTransaction`.