Skip to content

Commit fd840ee

Browse files
committed
readme updates
1 parent 0e616bb commit fd840ee

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Spin up your entire dev stack with one command.
4343
- [Integration: dotenv-vault](#integration-dotenv-vault)
4444
- [Integration: Telegram Notifications](#integration-telegram-notifications)
4545
- [Integration: Slack Notifications](#integration-slack-notifications)
46+
- [Integration: Desktop Notifications](#integration-desktop-notifications)
4647
- [Scripting](#scripting)
4748
- [Available Functions](#available-functions)
4849
- [Script Classes](#script-classes)
@@ -521,6 +522,20 @@ notifications.Slack().Message("hello from stackup, test 123").Send()
521522
notifications.Slack().Message("hello from stackup, test 456").To($SLACK_CHANNEL_1).Send()
522523
```
523524

525+
### Integration: Desktop Notifications
526+
527+
`StackUp` includes an integration for displaying desktop notifications. To configure the integration, see the [Desktop Notifications](#configuration-settings-notifications-desktop) section of the [Configuration: Settings](#configuration-settings) documentation.
528+
529+
Notifications are sent using javascript:
530+
531+
```js
532+
// display a desktop notification
533+
notifications.Desktop().Message("hello from stackup").Send()
534+
535+
// optionally provide a notification title
536+
notifications.Desktop().Message("hello from stackup", "some title").Send()
537+
```
538+
524539
## Scripting
525540

526541
Many of the fields in a `Task` can be defined using javascript. To specify an expression to be evaluated, wrap the content in double braces: `{{ env("HOME") }}`.

0 commit comments

Comments
 (0)