aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorVidhu Kant Sharma <vidhukant@vidhukant.com>2025-09-13 00:20:42 +0530
committerVidhu Kant Sharma <vidhukant@vidhukant.com>2025-09-13 00:20:42 +0530
commit330328d5ac6c633f117127b64b239631ca28277e (patch)
tree31be37cfcbc28cf15772c74e69f9bad959747890 /README.md
parenta85293cb7e755d5b81676088db205388488763a7 (diff)
Added notificationsv0.2.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 12 insertions, 7 deletions
diff --git a/README.md b/README.md
index f8bcf3a..c6fe6e9 100644
--- a/README.md
+++ b/README.md
@@ -98,6 +98,10 @@ Otherwise, do a hard reset (running this command twice in a row would always do
hard reset). This command is useful for polybar's click response, as we don't have
much room for multiple commands.
+#### polydoro notify
+
+Toggle desktop notifications.
+
## Configuration
Config is passed as environment variables.
@@ -108,17 +112,18 @@ In the polydoro daemon we have the following options:
**Note: All duration values are in seconds.**
-| Variable | Description | Default Value |
-| --------------------- | ------------------------------------- | ----------------- |
-| `WORK_DURATION` | Duration of the work timer | 1500 (25 minutes) |
-| `BREAK_DURATION` | Duration of the short break timer | 300 (5 minutes) |
-| `LONG_BREAK_DURATION` | Duration of the long break timer | 1200 (20 minutes) |
-| `LONG_BREAK_INTERVAL` | Number of work cycles till long break | 4 |
+| Variable | Description | Default Value |
+| --------------------- | ------------------------------------------------------------- | ----------------- |
+| `WORK_DURATION` | Duration of the work timer | 1500 (25 minutes) |
+| `BREAK_DURATION` | Duration of the short break timer | 300 (5 minutes) |
+| `LONG_BREAK_DURATION` | Duration of the long break timer | 1200 (20 minutes) |
+| `LONG_BREAK_INTERVAL` | Number of work cycles till long break | 4 |
+| `NOTIFY` | If set to `true` to start up with the notifications turned on | `false` |
Example:
```fish
-WORK_DURATION=1200 polydoro -d
+WORK_DURATION=1200 NOTIFY=true polydoro -d
```
### Listener config