summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTadek Teleżyński <tadekte@gmail.com>2017-08-17 22:54:26 +0300
committerTadek Teleżyński <tadekte@gmail.com>2017-08-17 22:54:26 +0300
commit582edf200c825abbc75ec8a643b2e7ecdbd59561 (patch)
tree44c6ab86ec6b11a3a3022276a1e76ffde4f6145c /README.md
parent9f4faf7f21a992f32114f134dfb0737657241b37 (diff)
Add average choice to load extension
This commit adds a functionality to choose if one wants to see 1, 5 or 15 minutes average. Resolves issue #604
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9c17c2c5..9c0c3ab5 100644
--- a/README.md
+++ b/README.md
@@ -96,7 +96,7 @@ The segments that are currently available are:
* [`ip`](#ip) - Shows the current IP address.
* [`vpn`](#vpn) - Shows the current VPN IP address.
* [`public_ip`](#public_ip) - Shows your public IP address.
-* `load` - Your machine's load averages.
+* [`load`](#load) - Your machine's load averages.
* `os_icon` - Display a nice little icon, depending on your operating system.
* `ram` - Show free RAM.
* `root_indicator` - An indicator if the user has superuser status.
@@ -482,6 +482,17 @@ segment will not be displayed.
|`POWERLEVEL9K_PUBLIC_IP_METHODS`|(dig curl wget)| These methods in that order are used to refresh your IP.|
|`POWERLEVEL9K_PUBLIC_IP_NONE`|None|The string displayed when an IP was not obtained|
+##### load
+
+Displays one of your load averages with appropriate state coloring. The thresholds are:
+- `0.7 * NUM_CORES <`: critical
+- `0.5 * NUM_CORES <`: warning
+- `less`: normal
+
+| Variable | Default Value | Description |
+|----------|---------------|-------------|
+|`POWERLEVEL9K_LOAD_WHICH`|5|Which average to show. Possible values: 1, 5 or 15|
+
##### newline
Puts a newline in your prompt so you can continue using segments on the next