Skip to content

Commit 392ad90

Browse files
authored
Fix documentation of interval attribute (#48)
1 parent dab4e2a commit 392ad90

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,13 +138,24 @@ Any widget is build up the following way:
138138
```toml
139139
[[keys]]
140140
index = 0
141-
interval = 500 # optional
142141
```
143142

144143
`index` needs to be present in every widget and describes the position of the
145144
widget on the streamdeck. `index` is 0-indexed and counted from top to bottom
146-
and left to right. The attribute `interval` defines the time in `ms` between two
147-
consecutive updates of the widget.
145+
and left to right.
146+
147+
#### Update interval for widgets
148+
149+
Optionally, you can configure an update `interval` for each widget:
150+
151+
```toml
152+
[keys.widget]
153+
id = "button"
154+
interval = 500 # optional
155+
```
156+
157+
The attribute `interval` defines the time in `ms` between two consecutive
158+
updates of a widget.
148159

149160
#### Button
150161

0 commit comments

Comments
 (0)
⌂ 换网址