docs(options): options of node-notifier

Turbo87 · Mar 21, 2022 · c8022dd · c8022dd
1 parent d6a6ae5
commit c8022dd
Showing 1 changed file with 9 additions and 0 deletions.
diff --git 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.