battery: add README (#7309)

This commit is contained in:
John Oerter 2018-10-18 13:58:14 -05:00 committed by Marc Cornellà
parent 5460333363
commit 3a8b93727f

13
plugins/battery/README.md Normal file
View File

@ -0,0 +1,13 @@
# Battery Plugin
This plugin adds some functions you can use to display battery information in your custom theme.
To use, add `battery` to the list of plugins in your `.zshrc` file:
`plugins=(... battery)`
Then, add the `battery_pct_prompt` function to your custom theme. For example:
```
RPROMPT='$(battery_pct_prompt)'
```