# update-notice

> Update notifications for CLI.

Latest version **0.1.3** (published 2019-07-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install update-notice
pnpm add update-notice
yarn add update-notice
bun add update-notice
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2019-07-12 |
| First published | 2018-08-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 20.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | mochen |
| Maintainers | imochen |
| Keywords | update, notice, notifier, tip |

## Links

- npm: https://www.npmjs.com/package/update-notice
- Repository: https://github.com/imochen/update-notice
- Homepage: https://github.com/imochen/update-notice#readme
- Issues: https://github.com/imochen/update-notice/issues
- npm.io page: https://npm.io/package/update-notice

## Dependencies (3)

- [boxen](https://npm.io/package/boxen.md) ^1.3.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [semver](https://npm.io/package/semver.md) ^5.5.1

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 0.1.3 (latest) — 2019-07-12
- 0.1.2 — 2019-07-12
- 0.1.1 — 2018-08-20
- 0.1.0 — 2018-08-20

## README

# update-notice

> Update notifications for CLI.


![screenshot](./screenshot.png)

## Install
```bash
npm install update-notice --save
```

## Usage
```javascript
const updateNotice = require('update-notice');
const pkg = require('./package.json');

const notice = updateNotice({
  pkg,
  options: {
    registry: 'https://registry.npmjs.org', //set your own registry
    isSudo: true, // default false
    isGlobal: true, // default false
  },
});

notice.notify();

// notice.notify((chalk) => {
//   return 'Changelog ' + chalk.underline('/path/to/CHANGELOG.md');
// });
```

---
_Source: https://npm.io/package/update-notice · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
