summaryrefslogtreecommitdiffstats
path: root/docs/config/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/config/README.md')
-rw-r--r--docs/config/README.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index 400f7039d..784eea70f 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -1291,19 +1291,22 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm
The `helm` module shows the currently installed version of Helm.
-The module will be shown if any of the following conditions are met:
+By default the module will be shown if any of the following conditions are met:
- The current directory contains a `helmfile.yaml` file
- The current directory contains a `Chart.yaml` file
### Options
-| Option | Default | Description |
-| ---------- | ---------------------------------- | ------------------------------------------------ |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
-| `style` | `"bold white"` | The style for the module. |
-| `disabled` | `false` | Disables the `helm` module. |
+| Option | Default | Description |
+| ------------------- | ------------------------------------ | ------------------------------------------------ |
+| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
+| `detect_extensions` | `[]` | Which extensions should trigger this module. |
+| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
+| `detect_folders` | `[]` | Which folders should trigger this modules. |
+| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
+| `style` | `"bold white"` | The style for the module. |
+| `disabled` | `false` | Disables the `helm` module. |
### Variables