From f2da89b184c59bea83b100e2384bce6634571ce0 Mon Sep 17 00:00:00 2001
From: iGoX <code@igox.org>
Date: Fri, 24 Apr 2026 14:53:42 +0200
Subject: [PATCH] Update blink documentation (#9)

Reviewed-on: https://code.igox.org/iGoX/busylight/pulls/9
---
 README.md | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index e6d1731..6fcacdd 100644
--- a/README.md
+++ b/README.md
@@ -73,8 +73,8 @@ Or directly from **[busyLight-streamdeck-pluing](https://code.igox.org/iGoX/busy
 | /api/status/busy | POST / GET | n/a | Set the BusyLight in `busy` mode. Red color. Return a `status` object. |
 | /api/status/off | POST / GET | n/a | Shutdown the BusyLight. Return a `status` object. |
 | /api/status | GET | n/a | Retreive the current BusyLight status. Return a `status` object. |
-| /api/blink | POST | `blink` JSON object | Make the BusyLight blink. Preserves current color, status and brightness. Return a `status` object. |
-| /api/blink | GET | n/a | Retrieve the current BusyLight blink status. Return a `blink` object. |
+| /api/blink | POST | `blinkParam` JSON object | Make the BusyLight blink. Preserves current color, status and brightness. Return a `status` object. |
+| /api/blink | GET | n/a | Retrieve the current BusyLight blink status. Return a `blinkStatus` object. |
 | /api/blink/stop | POST | n/a | Stop the BusyLight blinking and restore previous state. Return a `status` object. |
 | /api/debug | GET | n/a | Retreive the full BusyLight status. |
 
@@ -106,7 +106,19 @@ Or directly from **[busyLight-streamdeck-pluing](https://code.igox.org/iGoX/busy
 
 `brightness`: LED brightness | float | [0.0 .. 1.0]
 
-### `blink` object
+### `blinkParam` object
+
+```json
+{
+  "frequency": 2,
+  "duration": 5.0,
+ 
+```
+
+`frequency`: blink frequency | integer | Hz  
+`duration`: total blink duration | float | seconds | 0 = endless  
+
+### `blinkStatus` object
 
 ```json
 {