diff --git a/README.md b/README.md index 6c725fd..fcd41c0 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ npm install --save node-notifier Standard usage, with cross-platform fallbacks as defined in the [reporter flow chart](./DECISION_FLOW.md). All of the options -below will work in some way or another on all platforms. +below will work in some way or another on most platforms. ```javascript const notifier = require('node-notifier'); @@ -64,7 +64,7 @@ notifier.notify( message: 'Hello from node, Mr. User!', icon: path.join(__dirname, 'coulson.jpg'), // Absolute path (doesn't work on balloons) sound: true, // Only Notification Center or Windows Toasters - wait: true // Wait with callback, until user action is taken against notification, does not apply to Windows Toasters as they always wait + wait: true // Wait with callback, until user action is taken against notification, does not apply to Windows Toasters as they always wait or notify-send as it does not support the wait option }, function(err, response) { // Response is response from notification @@ -443,7 +443,9 @@ node: { ## License -[MIT License](http://en.wikipedia.org/wiki/MIT_License) +This package is licensed using the [MIT License](http://en.wikipedia.org/wiki/MIT_License). + +[SnoreToast](https://raw.githubusercontent.com/mikaelbr/node-notifier/master/vendor/snoreToast/LICENSE) and [Notifu](https://raw.githubusercontent.com/mikaelbr/node-notifier/master/vendor/notifu/LICENSE) have licenses in their vendored versions which do not match the MIT license, LGPL-3 and BSD 3-Clause to be specific. We are not lawyers, but have made our best efforts to conform to the terms in those licenses while releasing this package using the license we chose. [npm-url]: https://npmjs.org/package/node-notifier [npm-image]: http://img.shields.io/npm/v/node-notifier.svg?style=flat diff --git a/example/forceBallon.js b/example/forceBallon.js new file mode 100644 index 0000000..00af153 --- /dev/null +++ b/example/forceBallon.js @@ -0,0 +1,9 @@ +const notifier = require('../index'); +const balloon = notifier.WindowsBalloon(); +balloon + .notify({ message: 'Hello' }, function(err, data) { + console.log(err, data); + }) + .on('click', function() { + console.log(arguments); + }); diff --git a/notifiers/balloon.js b/notifiers/balloon.js index 4eed43e..c339d5d 100644 --- a/notifiers/balloon.js +++ b/notifiers/balloon.js @@ -14,6 +14,7 @@ Usage /q Do not play a sound when the tooltip is displayed /w Show the tooltip even if the user is in the quiet period that follows his very first login (Windows 7 and up) /xp Use IUserNotification interface event when IUserNotification2 is available +/l Display license for notifu // Kill codes: 2 = Timeout diff --git a/vendor/notifu/LICENSE b/vendor/notifu/LICENSE new file mode 100644 index 0000000..994c0ca --- /dev/null +++ b/vendor/notifu/LICENSE @@ -0,0 +1,25 @@ +// Retrieved from notifu 1.7.0 ( http://www.paralint.com/projects/notifu/index.html ) +Copyright (c) 2019, Solutions Paralint inc. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + * Neither the name of the nor the + names of its contributors may be used to endorse or promote products + derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY +DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/vendor/snoreToast/LICENSE b/vendor/snoreToast/LICENSE index 02bbb60..f579bb7 100644 --- a/vendor/snoreToast/LICENSE +++ b/vendor/snoreToast/LICENSE @@ -1,3 +1,4 @@ +// Retrieved from https://github.com/KDE/snoretoast/blob/master/COPYING.LGPL-3 version 0.7.0 GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007