Skip to content

Commit

Permalink
Tidelift tasks
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed May 31, 2019
1 parent 72f83d1 commit 1712928
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 25 deletions.
3 changes: 3 additions & 0 deletions .github/security.md
Original file line number Diff line number Diff line change
@@ -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.
40 changes: 15 additions & 25 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


---

<div align="center">
<b>
<a href="https://tidelift.com/subscription/pkg/npm-update_notifier?utm_source=npm-update-notifier&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
</b>
<br>
<sub>
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
</sub>
</div>

---


## API

### notifier = updateNotifier(options)
Expand All @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -177,7 +164,7 @@ Include the `-g` argument in the default message's `npm i` recommendation. You m

##### boxenOpts

Type: `Object`<br>
Type: `object`<br>
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).
Expand Down Expand Up @@ -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
<div align="center">
<b>
<a href="https://tidelift.com/subscription/pkg/npm-update_notifier?utm_source=npm-update-notifier&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
</b>
<br>
<sub>
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
</sub>
</div>

0 comments on commit 1712928

Please sign in to comment.