# alfred-notifier

> Update notifications for your Alfred workflow

Latest version **0.2.3** (published 2017-11-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install alfred-notifier
pnpm add alfred-notifier
yarn add alfred-notifier
bun add alfred-notifier
```

## 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.2.3 |
| Published | 2017-11-20 |
| First published | 2016-09-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 72 |
| Author | Sam Verschueren |
| Maintainers | samverschueren, sindresorhus |
| Keywords | alfred, alfy, workflow, update, updater, notify, notifier, module, version |

## Links

- npm: https://www.npmjs.com/package/alfred-notifier
- Repository: https://github.com/SamVerschueren/alfred-notifier
- Homepage: https://github.com/SamVerschueren/alfred-notifier#readme
- Issues: https://github.com/SamVerschueren/alfred-notifier/issues
- npm.io page: https://npm.io/package/alfred-notifier

## Dependencies (7)

- [pify](https://npm.io/package/pify.md) ^3.0.0
- [execa](https://npm.io/package/execa.md) ^0.8.0
- [plist](https://npm.io/package/plist.md) ^2.0.1
- [semver](https://npm.io/package/semver.md) ^5.3.0
- [read-pkg](https://npm.io/package/read-pkg.md) ^2.0.0
- [cache-conf](https://npm.io/package/cache-conf.md) ^0.5.0
- [latest-version](https://npm.io/package/latest-version.md) ^3.1.0

## Recent versions

- 0.2.3 (latest) — 2017-11-20
- 0.2.2 — 2017-09-11
- 0.2.1 — 2017-06-22
- 0.2.0 — 2016-09-30
- 0.1.0 — 2016-09-07

## README

# alfred-notifier [![Build Status](https://travis-ci.org/SamVerschueren/alfred-notifier.svg?branch=master)](https://travis-ci.org/SamVerschueren/alfred-notifier)

> Update notifications for your [Alfred](https://www.alfredapp.com/) workflow

<img src="screenshot.png">


## Install

```
$ npm install --save alfred-notifier
```


## Usage

### Simple example

```js
const alfredNotifier = require('alfred-notifier');

alfredNotifier();
```

### Comprehensive example

```js
const alfy = require('alfy');
const alfredNotifier = require('alfred-notifier');

// Checks for available update and updates the `info.plist`
alfredNotifier();

alfy.output([
	{title: '🦄'},
	{title: '🌈'}
]);
```


## API

### alfredNotifier()

Checks if there is an available update. If an update is available, it will add a message as subtext of your workflow.


## License

MIT © [Sam Verschueren](https://github.com/SamVerschueren)

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