diff --git a/.github/security.md b/.github/security.md new file mode 100644 index 0000000..5358dc5 --- /dev/null +++ b/.github/security.md @@ -0,0 +1,3 @@ +# Security Policy + +To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. diff --git a/readme.md b/readme.md index f9999a5..f59274c 100644 --- a/readme.md +++ b/readme.md @@ -80,21 +80,6 @@ The update check is done in a unref'ed [child process](https://nodejs.org/api/ch The first time the user runs your app, it will check for an update, and even if an update is available, it will wait the specified `updateCheckInterval` before notifying the user. This is done to not be annoying to the user, but might surprise you as an implementer if you're testing whether it works. Check out [`example.js`](example.js) to quickly test out `update-notifier` and see how you can test that it works in your app. ---- - -
- - Get professional support for this package with a Tidelift subscription - -
- - Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies. -
-
- ---- - - ## API ### notifier = updateNotifier(options) @@ -103,9 +88,11 @@ Checks if there is an available update. Accepts options defined below. Returns a ### options +Type: `object` + #### pkg -Type: `Object` +Type: `object` ##### name @@ -152,7 +139,7 @@ Only notifies if there is an update and the process is [TTY](https://nodejs.org/ #### options -Type: `Object` +Type: `object` ##### defer @@ -177,7 +164,7 @@ Include the `-g` argument in the default message's `npm i` recommendation. You m ##### boxenOpts -Type: `Object`
+Type: `object`
Default: `{padding: 1, margin: 1, align: 'center', borderColor: 'yellow', borderStyle: 'round'}` *(See screenshot)* Options object that will be passed to [`boxen`](https://github.com/sindresorhus/boxen). @@ -211,11 +198,14 @@ There are a bunch projects using it: [And 2700+ more…](https://www.npmjs.org/browse/depended/update-notifier) -## Security - -To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. - - -## License +--- -BSD-2-Clause © Google +
+ + Get professional support for this package with a Tidelift subscription + +
+ + Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies. +
+