From 78c796478327be7f6936aefb62a0e1f0f1c94d24 Mon Sep 17 00:00:00 2001
From: thyttan <6uuxstm66@mozmail.com⁩>
Date: Sat, 22 Mar 2025 11:13:48 +0100
Subject: [PATCH] voldisp: add README with some notes re widgets and
 performance

---
 apps/voldisp/README.md     | 15 +++++++++++++++
 apps/voldisp/metadata.json |  1 +
 2 files changed, 16 insertions(+)
 create mode 100644 apps/voldisp/README.md

diff --git a/apps/voldisp/README.md b/apps/voldisp/README.md
new file mode 100644
index 000000000..e44d0fce5
--- /dev/null
+++ b/apps/voldisp/README.md
@@ -0,0 +1,15 @@
+# Display Volume for Android
+
+Display the media volume of your android device when it's changed. A bar shows up at the top of your Bangles screen. (Needs recent Gadgetbridge nightly or stable ver. 85 once out)
+
+## Notes
+
+- Widgets may redraw on top of the volume bar. There was an effort to mitigate this, but the code complexity was annoying.
+  - This is however preserved in the git history (by revert commits) so can be brought back by reverting (revert the revert commits...) if needed.
+- Indicator might appear laggy or to not update continuously.
+  - There seems to be a limitation to how often Gadgetbridge can send send the volume info from the Android device - when it's in the background (most of the time). If Gadgetbridge is in the foreground on Android the volume bar on the Bangle updates almost as fast as the one on the Android device itself.
+
+## Contributors
+
+thyttan
+
diff --git a/apps/voldisp/metadata.json b/apps/voldisp/metadata.json
index 6629cb8c1..3af0dc7fd 100644
--- a/apps/voldisp/metadata.json
+++ b/apps/voldisp/metadata.json
@@ -6,6 +6,7 @@
   "tags": "audio,media,android,volume,sound",
   "type": "bootloader",
   "supports" : ["BANGLEJS2"],
+  "readme": "README.md",
   "screenshots" : [
     { "url":"screenshot.png" }
   ],