summaryrefslogtreecommitdiff
path: root/plugins/battery
diff options
context:
space:
mode:
authorJohn Oerter <john@johnoerter.me>2018-10-18 13:58:14 -0500
committerMarc Cornellà <marc.cornella@live.com>2018-10-18 20:58:14 +0200
commit3a8b93727fd58ef99dd70b7899f71efa1e1d217f (patch)
tree62b30668e29ae04c25b10866e2cb734354d816e6 /plugins/battery
parent54603333634d057c5d2e1b2eb826eec5ce8fd706 (diff)
downloadzsh-3a8b93727fd58ef99dd70b7899f71efa1e1d217f.tar.gz
zsh-3a8b93727fd58ef99dd70b7899f71efa1e1d217f.tar.bz2
zsh-3a8b93727fd58ef99dd70b7899f71efa1e1d217f.zip
battery: add README (#7309)
Diffstat (limited to 'plugins/battery')
-rw-r--r--plugins/battery/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/plugins/battery/README.md b/plugins/battery/README.md
new file mode 100644
index 000000000..b7a13a7ec
--- /dev/null
+++ b/plugins/battery/README.md
@@ -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)'
+```