adds README for examples

This commit is contained in:
onyx-and-iris 2023-11-29 16:54:12 +00:00
parent 70f76797ea
commit 9c5cfbdc7b
2 changed files with 18 additions and 1 deletions

4
.gitignore vendored
View File

@ -106,4 +106,6 @@ logfile/*
*.psd1
# config
config.psd1
config.psd1
notes.txt

15
examples/README.md Normal file
View File

@ -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`