Skip to content

Commit 0dbe072

Browse files
committed
Meta tweaks
1 parent 4a62e50 commit 0dbe072

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
"version"
3939
],
4040
"dependencies": {
41-
"boxen": "^8.0.0",
41+
"boxen": "^8.0.1",
4242
"chalk": "^5.3.0",
4343
"configstore": "^7.0.0",
4444
"is-in-ci": "^1.0.0",
@@ -55,7 +55,7 @@
5555
"esmock": "^2.6.7",
5656
"fixture-stdout": "^0.2.1",
5757
"strip-ansi": "^7.1.0",
58-
"xo": "^0.59.2"
58+
"xo": "^0.59.3"
5959
},
6060
"ava": {
6161
"timeout": "20s",

readme.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
![](screenshot.png)
66

7-
Inform users of your package of updates in a non-intrusive way.
7+
Inform users of updates for your package in a non-intrusive way.
88

99
#### Contents
1010

@@ -23,7 +23,7 @@ npm install update-notifier
2323

2424
## Usage
2525

26-
### Simple
26+
### Basic
2727

2828
```js
2929
import updateNotifier from 'update-notifier';
@@ -32,7 +32,7 @@ import packageJson from './package.json' assert {type: 'json'};
3232
updateNotifier({pkg: packageJson}).notify();
3333
```
3434

35-
### Comprehensive
35+
### Advanced
3636

3737
```js
3838
import updateNotifier from 'update-notifier';
@@ -69,10 +69,10 @@ if (notifier.update) {
6969
}
7070
```
7171

72-
## How
72+
## How it works
7373

7474
Whenever you initiate the update notifier and it's not within the interval threshold, it will asynchronously check with npm in the background for available updates, then persist the result. The next time the notifier is initiated, the result will be loaded into the `.update` property. This prevents any impact on your package startup performance.
75-
The update check is done in a unref'ed [child process](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options). This means that if you call `process.exit`, the check will still be performed in its own process.
75+
The update check is done in an unref'ed [child process](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options). This means that if you call `process.exit`, the check will still be performed in its own process.
7676

7777
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.
7878

@@ -129,7 +129,7 @@ Returns an `object` with:
129129

130130
- `latest` *(string)* - Latest version.
131131
- `current` *(string)* - Current version.
132-
- `type` *(string)* - Type of current update. Possible values: `latest`, `major`, `minor`, `patch`, `prerelease`, `build`.
132+
- `type` *(string)* - Type of the current update. Possible values: `latest`, `major`, `minor`, `patch`, `prerelease`, `build`.
133133
- `name` *(string)* - Package name.
134134

135135
### notifier.notify(options?)
@@ -147,7 +147,7 @@ Type: `object`
147147
Type: `boolean`\
148148
Default: `true`
149149

150-
Defer showing the notification to after the process has exited.
150+
Defer showing the notification until after the process has exited.
151151

152152
##### message
153153

@@ -200,12 +200,12 @@ The idea for this module came from the desire to apply the browser update strate
200200

201201
## Users
202202

203-
There are a bunch projects using it:
203+
There are a bunch of projects using it:
204204

205205
- [npm](https://github.com/npm/npm) - Package manager for JavaScript
206206
- [Yeoman](https://yeoman.io) - Modern workflows for modern webapps
207207
- [AVA](https://avajs.dev) - Simple concurrent test runner
208208
- [XO](https://github.com/xojs/xo) - JavaScript happiness style linter
209209
- [Node GH](https://github.com/node-gh/gh) - GitHub command line tool
210210

211-
[And 2700+ more…](https://www.npmjs.org/browse/depended/update-notifier)
211+
[And 5000+ more…](https://www.npmjs.org/browse/depended/update-notifier)

0 commit comments

Comments
 (0)