From ffdfe98b92cbda40b0822c58649973689cfb0cf4 Mon Sep 17 00:00:00 2001
From: thyttan <6uuxstm66@mozmail.com⁩>
Date: Sun, 25 Aug 2024 12:12:51 +0200
Subject: [PATCH] pomoplus: add README.md

---
 apps/pomoplus/README.md     | 39 +++++++++++++++++++++++++++++++++++++
 apps/pomoplus/metadata.json |  1 +
 2 files changed, 40 insertions(+)
 create mode 100644 apps/pomoplus/README.md

diff --git a/apps/pomoplus/README.md b/apps/pomoplus/README.md
new file mode 100644
index 000000000..0e8170f50
--- /dev/null
+++ b/apps/pomoplus/README.md
@@ -0,0 +1,39 @@
+# Pomodoro Plus
+
+> The Pomodoro Technique is a time management method developed by Francesco Cirillo in the late 1980s. It uses a kitchen timer to break work into intervals, typically 25 minutes in length, separated by short breaks. Each interval is known as a pomodoro, from the Italian word for tomato, after the tomato-shaped kitchen timer Cirillo used as a university student.
+>
+> The original technique has six steps:
+>
+> Decide on the task to be done.
+> Set the Pomodoro timer (typically for 25 minutes).
+> Work on the task.
+> End work when the timer rings and take a short break (typically 5–10 minutes).
+> Go back to Step 2 and repeat until you complete four pomodori.
+> After four pomodori are done, take a long break (typically 20 to 30 minutes) instead of a short break. Once the long break is finished, return to step 2.
+
+*Description gathered from https://en.wikipedia.org/wiki/Pomodoro_Technique*
+
+## Usage
+
+- Click the play button to start a pomodoro and get to work!
+- Click the pause button if you're interrupted with something urgent.
+- Click the cross button if you need to end your work session.
+- Click the skip button if you forgot to start the pomodori after the urgent interruption and ended up working for a long time! (Good on ya'!)
+
+Configure the pomodori and break times in the settings.
+
+## Features
+
+Continues to run in the background if you exit the app while the pomodoro timer is running.
+
+## Requests
+
+Open an issue on the espruino/BangleApps issue tracker.
+
+## Creator
+
+bruceblore
+
+## Contributors
+
+notEvil, thyttan
diff --git a/apps/pomoplus/metadata.json b/apps/pomoplus/metadata.json
index 1fd65de16..7b1efee2a 100644
--- a/apps/pomoplus/metadata.json
+++ b/apps/pomoplus/metadata.json
@@ -10,6 +10,7 @@
     "BANGLEJS",
     "BANGLEJS2"
   ],
+  "readme": "README.md",
   "storage": [
     {
       "name": "pomoplus.app.js",