# @zeit/check-updates

> Consistent update notifications for packages

Latest version **1.1.1** (published 2018-03-06) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @zeit/check-updates
pnpm add @zeit/check-updates
yarn add @zeit/check-updates
bun add @zeit/check-updates
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2018-03-06 |
| First published | 2018-01-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 17.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | leo |
| Maintainers | arunoda, iamevilrabbit, igorklopov, jamo, javivelasco, leo, lipp, matheuss, nkzawa, olliv, pranaygp, qix, rauchg, sergiodxa, timneutkens, tootallnate, zeit-admin, zeit-bot |
| Keywords | update, notifier |

## Links

- npm: https://www.npmjs.com/package/@zeit/check-updates
- Repository: https://github.com/zeit/check-updates
- Homepage: https://github.com/zeit/check-updates#readme
- Issues: https://github.com/zeit/check-updates/issues
- npm.io page: https://npm.io/package/@zeit/check-updates

## Dependencies (3)

- [ms](https://npm.io/package/ms.md) 2.1.1
- [chalk](https://npm.io/package/chalk.md) 2.3.2
- [update-notifier](https://npm.io/package/update-notifier.md) 2.3.0

## Recent versions

- 1.1.1 (latest) — 2018-03-06
- 1.1.0 — 2018-01-20
- 1.0.5 — 2018-01-12
- 1.0.4 — 2018-01-12
- 1.0.3 — 2018-01-12
- 1.0.2 — 2018-01-12
- 1.0.1 — 2018-01-12
- 1.0.0 — 2018-01-12

## README

# check-updates

This package makes it very easy to implement update notifications into ZEIT packages:

<img width="900" alt="screen shot 2018-01-12 at 15 01 33" src="https://user-images.githubusercontent.com/6170607/34878177-8b2aa826-f7a9-11e7-90df-2c3c7f02a774.png">

## Usage

Firstly, install the package:

```bash
npm install @zeit/check-updates
```

Next, initialize it:

```js
const pkg = require('./package')
const updateNotifier = require('@zeit/check-updates')

updateNotifier(pkg, 'Project Name')
```

You can even pass a millisecond interval for the cache (a day by default):

```js
updateNotifier(pkg, 'Project Name', 80000)
```

## Contributing

1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device
2. Link the package to the global module directory: `npm link`
3. Within the module you want to test your local development instance of the package, just link it: `npm link @zeit/check-updates`. Instead of the default one from npm, node will now use your clone.

## Author

Leo Lamprecht ([@notquiteleo](https://twitter.com/notquiteleo)) - [ZEIT](https://zeit.co)

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