summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMatan Kushner <hello@matchai.me>2019-09-30 16:04:49 +0900
committerGitHub <noreply@github.com>2019-09-30 16:04:49 +0900
commit9e9eb6a8ef87f7b93dc07e0cf068ccb1a6ce588c (patch)
tree87a88f8dba4ea5734c46700dba6864b25d733dcd /docs
parent7588137b09f7706cc404a986113b277d99fde859 (diff)
fix: Disable memory_usage by default (#451)
Diffstat (limited to 'docs')
-rw-r--r--docs/config/README.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index 0defe8268..f0eb2963b 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -580,6 +580,13 @@ The `memory_usage` module shows current system memory and swap usage.
By default the swap usage is displayed if the total system swap is non-zero.
+::: tip
+
+This module is disabled by default.
+To enable it, set `disabled` to `false` in your configuration file.
+
+:::
+
### Options
| Variable | Default | Description |
@@ -589,7 +596,7 @@ By default the swap usage is displayed if the total system swap is non-zero.
| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `symbol` | `"🐏 "` | The symbol used before displaying the memory usage. |
| `style` | `"bold dimmed white"` | The style for the module. |
-| `disabled` | `false` | Disables the `memory_usage` module. |
+| `disabled` | `true` | Disables the `memory_usage` module. |
### Example