Skip to content

Commit

Permalink
Fix documentation of interval attribute (#48)
Browse files Browse the repository at this point in the history
  • Loading branch information
HoodedDeath authored Aug 24, 2021
1 parent dab4e2a commit 392ad90
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,13 +138,24 @@ Any widget is build up the following way:
```toml
[[keys]]
index = 0
interval = 500 # optional
```

`index` needs to be present in every widget and describes the position of the
widget on the streamdeck. `index` is 0-indexed and counted from top to bottom
and left to right. The attribute `interval` defines the time in `ms` between two
consecutive updates of the widget.
and left to right.

#### Update interval for widgets

Optionally, you can configure an update `interval` for each widget:

```toml
[keys.widget]
id = "button"
interval = 500 # optional
```

The attribute `interval` defines the time in `ms` between two consecutive
updates of a widget.

#### Button

Expand Down

0 comments on commit 392ad90

Please sign in to comment.