Skip to content

Commit

Permalink
Fix docs position of shouldNotifyInNpmScript (#143)
Browse files Browse the repository at this point in the history
  • Loading branch information
renatoagds authored and sindresorhus committed Sep 12, 2018
1 parent d371834 commit 8df01b3
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,13 @@ Type: `Function`

Passing a callback here will make it check for an update directly and report right away. Not recommended as you won't get the benefits explained in [`How`](#how). `update` is equal to `notifier.update`.

#### shouldNotifyInNpmScript

Type: `boolean`<br>
Default: `false`

Allows notification to be shown when running as an npm script.

### notifier.notify([options])

Convenience method to display a notification message. *(See screenshot)*
Expand Down Expand Up @@ -153,12 +160,6 @@ 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

Expand Down

0 comments on commit 8df01b3

Please # to comment.