From 80e5eff3bdb5f7b6e0ce4e0a0c60b3296358e9fd Mon Sep 17 00:00:00 2001
From: Martin Boonk <martin@boonk.info>
Date: Sat, 19 Feb 2022 02:58:08 +0100
Subject: [PATCH] Adds readme file

---
 apps/imageclock/README.md     | 49 +++++++++++++++++++++++++++++++++++
 apps/imageclock/metadata.json |  1 +
 2 files changed, 50 insertions(+)
 create mode 100644 apps/imageclock/README.md

diff --git a/apps/imageclock/README.md b/apps/imageclock/README.md
new file mode 100644
index 000000000..5d45d4f2c
--- /dev/null
+++ b/apps/imageclock/README.md
@@ -0,0 +1,49 @@
+# Imageclock
+
+This app is a highly customizable watchface. To use it, you need to select
+a watchface from another source.
+
+## Usage
+
+Choose the folder which contains the watchface, then clock "Upload to watch".
+
+## Design watch faces
+
+### Folder structure
+
+
+* watchfacename
+  * resources/
+  * face.json
+  * info.json
+
+
+#### resources
+
+This folder contains image files. It can have subfolders. These files will
+be read and converted into a resource bundle used by the clock
+
+#### face.json
+
+This file contains the description of the watch face elements.
+
+#### info.json
+
+This file contains information for the conversion process, it will not be 
+stored on the watch
+
+## TODO
+
+* Performance improvements
+  * Mark elements with how often they need to be redrawn
+  * Use less RAM (maybe dedicated parser for JSON working on a stack/queue)
+* Allow watchfaces to declare if the want to show widgets
+* Temporarily show widgets with slide up/down
+* Analog Hands?
+* Finalize the file format
+* Description of the file format
+* Allow additional files for upload declared in info.json
+
+## Creator
+
+[halemmerich](https://github.com/halemmerich)
diff --git a/apps/imageclock/metadata.json b/apps/imageclock/metadata.json
index 9807b5271..319cf17aa 100644
--- a/apps/imageclock/metadata.json
+++ b/apps/imageclock/metadata.json
@@ -10,6 +10,7 @@
   "supports": ["BANGLEJS2"],
   "custom": "custom.html",
   "customConnect": false,
+  "readme": "README.md",
   "storage": [
     {"name":"imageclock.app.js","url":"app.js"},
     {"name":"imageclock.img","url":"app-icon.js","evaluate":true}