Skip to content

Commit

Permalink
Merge pull request #591 from jolicode/doc-notification
Browse files Browse the repository at this point in the history
Clarification about desktop notification
  • Loading branch information
pyrech authored Dec 10, 2024
2 parents 7592ee8 + b6fe008 commit 902c05d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/going-further/helpers/notify.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Notification
# Desktop notification

Castor uses the [JoliNotif](https://github.com/jolicode/jolinotif) library to
display notifications.
display desktop notifications.

## The `notify()` function

Expand All @@ -22,7 +22,7 @@ function notify()
## Notify with `run()`

You can use the `withNotify` method of the `Context` object to display a
notification when a command has been executed:
desktop notification when a command has been executed:

```php
use Castor\Attribute\AsTask;
Expand Down Expand Up @@ -93,7 +93,7 @@ function notify()

Finally, you can set the `notify` property in the context to `true` to enable notifications globally:

In that case, any call to the `notify()` function will display a notification. (user or Castor generated notifications)
In that case, any call to the `notify()` function will display a desktop notification (user or Castor generated notifications).

```php
use Castor\Attribute\AsTask;
Expand Down

0 comments on commit 902c05d

Please sign in to comment.