diff options
Diffstat (limited to 'node_modules/update-notifier/readme.md')
| -rw-r--r-- | node_modules/update-notifier/readme.md | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/node_modules/update-notifier/readme.md b/node_modules/update-notifier/readme.md index 99e73976e..ef6a1a8b1 100644 --- a/node_modules/update-notifier/readme.md +++ b/node_modules/update-notifier/readme.md @@ -23,7 +23,7 @@ $ npm install update-notifier ``` -## Usafe +## Usage ### Simple @@ -153,12 +153,21 @@ Default: `{padding: 1, margin: 1, align: 'center', borderColor: 'yellow', border Options object that will be passed to [`boxen`](https://github.com/sindresorhus/boxen). +##### shouldNotifyInNpmScript + +Type: `boolean`<br> +Default: `false` + +Allows notification to be shown when running as an npm script. + ### User settings Users of your module have the ability to opt-out of the update notifier by changing the `optOut` property to `true` in `~/.config/configstore/update-notifier-[your-module-name].json`. The path is available in `notifier.config.path`. Users can also opt-out by [setting the environment variable](https://github.com/sindresorhus/guides/blob/master/set-environment-variables.md) `NO_UPDATE_NOTIFIER` with any value or by using the `--no-update-notifier` flag on a per run basis. +The check is also skipped on CI automatically. + ## About @@ -172,7 +181,7 @@ There are a bunch projects using it: - [npm](https://github.com/npm/npm) - Package manager for JavaScript - [Yeoman](http://yeoman.io) - Modern workflows for modern webapps - [AVA](https://ava.li) - Simple concurrent test runner -- [XO](https://github.com/sindresorhus/xo) - JavaScript happiness style linter +- [XO](https://github.com/xojs/xo) - JavaScript happiness style linter - [Pageres](https://github.com/sindresorhus/pageres) - Capture website screenshots - [Node GH](http://nodegh.io) - GitHub command line tool @@ -181,4 +190,4 @@ There are a bunch projects using it: ## License -[BSD license](http://opensource.org/licenses/bsd-license.php) and copyright Google +BSD-2-Clause © Google |