Skip to content

Commit 1712928

Browse files
committed
Tidelift tasks
1 parent 72f83d1 commit 1712928

File tree

2 files changed

+18
-25
lines changed

2 files changed

+18
-25
lines changed

.github/security.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Security Policy
2+
3+
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.

readme.md

+15-25
Original file line numberDiff line numberDiff line change
@@ -80,21 +80,6 @@ The update check is done in a unref'ed [child process](https://nodejs.org/api/ch
8080
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.
8181

8282

83-
---
84-
85-
<div align="center">
86-
<b>
87-
<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>
88-
</b>
89-
<br>
90-
<sub>
91-
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
92-
</sub>
93-
</div>
94-
95-
---
96-
97-
9883
## API
9984

10085
### notifier = updateNotifier(options)
@@ -103,9 +88,11 @@ Checks if there is an available update. Accepts options defined below. Returns a
10388

10489
### options
10590

91+
Type: `object`
92+
10693
#### pkg
10794

108-
Type: `Object`
95+
Type: `object`
10996

11097
##### name
11198

@@ -152,7 +139,7 @@ Only notifies if there is an update and the process is [TTY](https://nodejs.org/
152139

153140
#### options
154141

155-
Type: `Object`
142+
Type: `object`
156143

157144
##### defer
158145

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

178165
##### boxenOpts
179166

180-
Type: `Object`<br>
167+
Type: `object`<br>
181168
Default: `{padding: 1, margin: 1, align: 'center', borderColor: 'yellow', borderStyle: 'round'}` *(See screenshot)*
182169

183170
Options object that will be passed to [`boxen`](https://github.com/sindresorhus/boxen).
@@ -211,11 +198,14 @@ There are a bunch projects using it:
211198
[And 2700+ more…](https://www.npmjs.org/browse/depended/update-notifier)
212199

213200

214-
## Security
215-
216-
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
217-
218-
219-
## License
201+
---
220202

221-
BSD-2-Clause © Google
203+
<div align="center">
204+
<b>
205+
<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>
206+
</b>
207+
<br>
208+
<sub>
209+
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
210+
</sub>
211+
</div>

0 commit comments

Comments
 (0)