summaryrefslogtreecommitdiff
path: root/plugins/battery/README.md
diff options
context:
space:
mode:
authorAvneet Singh <4151485+kalsi-avneet@users.noreply.github.com>2021-03-21 00:06:33 +0530
committerMarc Cornellà <hello@mcornella.com>2021-10-08 12:27:16 +0200
commitf26a1ecdf01185218004dd6d15ce02541e6a2b26 (patch)
tree80d20d1b98e55ca3f091e8c0106d266485b3ee03 /plugins/battery/README.md
parentdc83d0b7204cf66315471e980729490813b7d915 (diff)
downloadzsh-f26a1ecdf01185218004dd6d15ce02541e6a2b26.tar.gz
zsh-f26a1ecdf01185218004dd6d15ce02541e6a2b26.tar.bz2
zsh-f26a1ecdf01185218004dd6d15ce02541e6a2b26.zip
feat(battery): add support for Android via Termux (#9752)
Diffstat (limited to 'plugins/battery/README.md')
-rw-r--r--plugins/battery/README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/plugins/battery/README.md b/plugins/battery/README.md
index c2554a36d..18e5bd882 100644
--- a/plugins/battery/README.md
+++ b/plugins/battery/README.md
@@ -8,15 +8,22 @@ To use, add `battery` to the list of plugins in your `.zshrc` file:
Then, add the `battery_pct_prompt` function to your custom theme. For example:
-```
+```zsh
RPROMPT='$(battery_pct_prompt) ...'
```
## Requirements
-On Linux, you must have the `acpi` tool installed on your operating system.
+- On Linux, you must have the `acpi` or `acpitool` commands installed on your operating system.
+ On Debian/Ubuntu, you can do that with `sudo apt install acpi` or `sudo apt install acpitool`.
-Here's an example of how to install with apt:
-```
-sudo apt-get install acpi
-```
+- On Android (via [Termux](https://play.google.com/store/apps/details?id=com.termux)), you must have:
+
+ 1. The `Termux:API` addon app installed:
+ [Google Play](https://play.google.com/store/apps/details?id=com.termux.api) | [F-Droid](https://f-droid.org/packages/com.termux.api/)
+
+ 2. The `termux-api` package installed within termux:
+
+ ```sh
+ pkg install termux-api
+ ```