From 9c5cfbdc7bb9456e6d99cb4f78b2d46bc7fbbab1 Mon Sep 17 00:00:00 2001
From: onyx-and-iris <code@onyxandiris.online>
Date: Wed, 29 Nov 2023 16:54:12 +0000
Subject: [PATCH] adds README for examples

---
 .gitignore         |  4 +++-
 examples/README.md | 15 +++++++++++++++
 2 files changed, 18 insertions(+), 1 deletion(-)
 create mode 100644 examples/README.md

diff --git a/.gitignore b/.gitignore
index b6b02c4..77981f0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -106,4 +106,6 @@ logfile/*
 *.psd1
 
 # config
-config.psd1
\ No newline at end of file
+config.psd1
+
+notes.txt
\ No newline at end of file
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 0000000..fd460df
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,15 @@
+# Use
+
+These examples load connection info from a file `config.psd1` placed next to the script files.
+
+```psd1
+@{
+    host   = "hostname.server"
+    port   = 28960
+    passwd = "strongrconpassword"
+}
+```
+
+Run them with -Debug flag for debug output.
+
+For example: `pwsh.exe .\cli.ps1 -Debug`