Update README.md

This commit is contained in:
Kip Gebhardt 2015-02-12 19:44:33 -08:00
parent d0250ac852
commit f3d501924e

View File

@ -1,3 +1,21 @@
An RSS Braider Module
[![Build Status](https://travis-ci.org/KQED/rss-braider.svg?branch=master)](https://travis-ci.org/KQED/rss-braider)
## Summary
A node.js module to braid or aggregate more than one RSS feed (file or url) into a single feed and process via specified plugins.
## Installation
```
$ git clone git@github.com:KQED/rss-braider.git
$ cd rss-braider
$ npm install
```
## Test
`npm test`
## Examples
```
$ cd examples
$ node simple.js
$ node plugins.js
```