# snok

> A super simple RSS sniffer

Latest version **0.0.4** (published 2016-11-27) · ISC license · 0 weekly downloads

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

## Install

```sh
npm install snok
pnpm add snok
yarn add snok
bun add snok
```

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2016-11-27 |
| First published | 2016-06-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mats Rörbecker |
| Maintainers | matsrorbecker |
| Keywords | RSS |

## Links

- npm: https://www.npmjs.com/package/snok
- Repository: https://github.com/matsrorbecker/snok
- Homepage: https://github.com/matsrorbecker/snok#readme
- Issues: https://github.com/matsrorbecker/snok/issues
- npm.io page: https://npm.io/package/snok

## Dependencies (2)

- [request](https://npm.io/package/request.md) ^2.72.0
- [feedparser](https://npm.io/package/feedparser.md) ^1.1.4

## Recent versions

- 0.0.4 (latest) — 2016-11-27
- 0.0.3 — 2016-06-29
- 0.0.2 — 2016-06-28
- 0.0.1 — 2016-06-28

## README

Snok
===========

###Snok is a super simple RSS sniffer that uses [Feedparser](https://github.com/danmactough/node-feedparser) to scan feeds for certain keywords and then... well, that's up to you.

Installation
------------

First you need to install [Node.js](https://nodejs.org/). After that, run the following command:

    npm install snok

Usage
-----
Just pass Snok the feeds, the triggers and a callback to handle the returned items. Example:

```javascript
const Snok = require('snok');

const feeds = [
	'https://news.ycombinator.com/rss'
]

const triggers = [
	'machine learning',
	'artificial intelligence',
	'automation',
	'AI && robotics' // Logical AND now supported
]

const notify = function (item) {
	console.log("Hey, there seems to be an interesting article out there!");
	console.log(item.link);
}

const secondsBetweenChecks = 60;

const snok = new Snok(feeds, triggers, notify);

setInterval(snok.sniff, secondsBetweenChecks * 1000);
snok.sniff();
```
    
License
-------

This little piece of software is licensed under the terms of the [ISC License](http://en.wikipedia.org/wiki/ISC_license).

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