From f3d501924e2518b2db92a76c6aba61af5c892067 Mon Sep 17 00:00:00 2001 From: Kip Gebhardt Date: Thu, 12 Feb 2015 19:44:33 -0800 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 600026e..1241116 100644 --- a/README.md +++ b/README.md @@ -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 +``` +