3a8b93727fd58ef99dd70b7899f71efa1e1d217f

Author
John Oerter <john@johnoerter.me>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

battery: add README (#7309)

Diff

 1diff --git a/plugins/battery/README.md b/plugins/battery/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..b7a13a7ecc2ac6aa79c1492d2d6e2cda8237155a
 4--- /dev/null
 5+++ b/plugins/battery/README.md
 6@@ -0,0 +1,13 @@
 7+# Battery Plugin
 8+
 9+This plugin adds some functions you can use to display battery information in your custom theme.
10+
11+To use, add `battery` to the list of plugins in your `.zshrc` file:
12+
13+`plugins=(... battery)`
14+
15+Then, add the `battery_pct_prompt` function to your custom theme. For example:
16+
17+```
18+RPROMPT='$(battery_pct_prompt)'
19+```