From 1b7a7ba0c9defc227f7865c0b754bb94d31dfa74 Mon Sep 17 00:00:00 2001
From: unknown <koos@cesbit.com>
Date: Mon, 6 Feb 2023 13:35:44 +0100
Subject: [PATCH] upd readme

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/README.md b/README.md
index 4d5459f..5f79675 100644
--- a/README.md
+++ b/README.md
@@ -22,3 +22,42 @@ Variable            | Default                        | Description
 ```
 docker build -t esx-probe . --no-cache
 ```
+
+## Config
+
+```yaml
+vcenter:
+  config:
+    username: "my_account"
+    password: "my_password"
+```
+
+## Dry run
+
+Available checks:
+- `alarms`
+- `capabilities`
+- `configIssues`
+- `datastore`
+- `hardwareStatus`
+- `host`
+- `hostVMs`
+- `licenses`
+- `network`
+- `sensor`
+
+Create a yaml file, for example _(test.yaml)_:
+
+```yaml
+asset:
+  name: "foo.local"
+  check: "host"
+  config:
+    address: "192.168.1.2"
+```
+
+Run the probe with the `DRY_RUN` environment variable set the the yaml file above.
+
+```
+DRY_RUN=test.yaml python main.py
+```