From 3a8b93727fd58ef99dd70b7899f71efa1e1d217f Mon Sep 17 00:00:00 2001
From: John Oerter <john@johnoerter.me>
Date: Thu, 18 Oct 2018 13:58:14 -0500
Subject: [PATCH] battery: add README (#7309)

---
 plugins/battery/README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 plugins/battery/README.md

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)'
+```