Updates to README and CHANGELOG for changes from #498.

This commit is contained in:
Ben Hilburn 2017-05-01 21:37:12 -04:00
parent 98a00d31a8
commit cae2a7927d
2 changed files with 23 additions and 15 deletions

View File

@ -1,3 +1,8 @@
## v0.6.4
- Significant enhancements to the `battery` segment. Check out the README to
read more!
## v0.6.3
- Fixed susceptibility to [pw3nage exploit](https://github.com/njhartwell/pw3nage).

View File

@ -200,14 +200,16 @@ Note that you can [modify the `_FOREGROUND`
color](https://github.com/bhilburn/powerlevel9k/wiki/Stylizing-Your-Prompt#segment-color-customization)
without affecting the icon color.
The battery segment can also be extended to change the icon automatically depending on the battery level.
This will override the default battery icon. In order to do this, you need to define the
`POWERLEVEL9k_BATTERY_STAGES` variable.
You can also change the battery icon automatically depending on the battery
level. This will override the default battery icon. In order to do this, you
need to define the `POWERLEVEL9k_BATTERY_STAGES` variable.
| Variable | Default Value | Description |
| `POWERLEVEL9K_BATTERY_STAGES`|Unset|A string or array to indicate the stages.|
| `POWERLEVEL9K_BATTERY_STAGES`|Unset|A string or array, which each index indicates a charge level.|
If you want to use a string, you can declare the variable as follows:
Powerlevel9k will use each index of the string or array as a stage to indicate battery
charge level, progressing from left to right. You can provide any number of
stages. The setting below, for example, provides 8 stages for Powerlevel9k to use.
```zsh
POWERLEVEL9K_BATTERY_STAGES="▁▂▃▄▅▆▇█"
```
@ -219,8 +221,8 @@ missing icon. To do this, declare the variable as follows:
POWERLEVEL9K_BATTERY_STAGES=($'\u2581 ' $'\u2582 ' $'\u2583 ' $'\u2584 ' $'\u2585 ' $'\u2586 ' $'\u2587 ' $'\u2588 ')
```
You can also use a multiple character "icon" if you want a longer battery icon. To do
this, declare the variable as follows:
Using the array syntax, you can create stages comprised of multiple characters.
The below setting provides 40 battery stages.
```zsh
POWERLEVEL9K_BATTERY_STAGES=(
$'▏ ▏' $'▎ ▏' $'▍ ▏' $'▌ ▏' $'▋ ▏' $'▊ ▏' $'▉ ▏' $'█ ▏'
@ -230,23 +232,24 @@ POWERLEVEL9K_BATTERY_STAGES=(
$'████ ▏' $'████▎▏' $'████▍▏' $'████▌▏' $'████▋▏' $'████▊▏' $'████▉▏' $'█████▏' )
```
It is now also possible to change the background of the segment automatically depending on
the battery level. This will override the following variables: `POWERLEVEL9K_BATTERY_CHARGING`,
`POWERLEVEL9K_BATTERY_CHARGED`, `POWERLEVEL9K_BATTERY_DISCONNECTED`, and `POWERLEVEL9K_BATTERY_LOW_COLOR`.
In order to do this, we define a color array (from low to high) as follows:
You can also change the background of the segment automatically depending on the
battery level. This will override the following variables:
`POWERLEVEL9K_BATTERY_CHARGING`, `POWERLEVEL9K_BATTERY_CHARGED`,
`POWERLEVEL9K_BATTERY_DISCONNECTED`, and `POWERLEVEL9K_BATTERY_LOW_COLOR`. In
order to do this, define a color array, from low to high, as shown below:
```zsh
POWERLEVEL9K_BATTERY_LEVEL_BACKGROUND=(196 202 208 214 220 226 190 154 118 82 46)
```
As with the battery stages, you can use any number of colors and Powerlevel9k
will automatically use all of them appropriately.
Some example settings:
|Brightness|Possible Array|
|Bright Colors|(196 202 208 214 220 226 190 154 118 82 46)|
|Normal Colors|(124 130 136 142 148 112 76 40 34 28 22)|
|Subdued Colors|( 88 94 100 106 70 34 28 22)|
Please note the following:
* an array declarations start with `(` and end with `)`.
* both the icon and background changing levels are automatically calculated, so they can be any length.
##### command_execution_time
Display the time the previous command took to execute if the time is above