From c8022dd49dd41e21d0154389adc7694611a96b8c Mon Sep 17 00:00:00 2001 From: Gvozd Date: Tue, 22 Mar 2022 00:05:25 +0300 Subject: [PATCH] docs(options): options of node-notifier --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 6072c65e..8e566203 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,15 @@ var config = module.exports = { ## Configuration +### All `node-notifier` options + +You can use any [node-notifier](https://www.npmjs.com/package/node-notifier) options (depending on your OS) +Except for options generated by the plugin itself: +* `title` - it can be not only a string, but also a function +* `message` - generated based on the value of other options +* `contentImage` - it can be an object with images for different statuses +* `icon` - matches with `contentImage` + ### Title Title shown in the notification.