martin/rss-braider
1
0
Fork 0
mirror of https://gitlab.silvrtree.co.uk/martind2000/rss-braider.git synced 2025-02-11 06:49:16 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Kip Gebhardt 2015-05-28 18:01:47 -07:00
parent 4f481552b7
commit f08f57ed72
1 changed files with 25 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -13,7 +13,30 @@ npm install rss-braider
## Examples ## Examples
``` ```
$ cd examples $ cd examples
$ node simple.js $ node simple.js (combines 3 sources)
$ node plugins.js $ node plugins.js (combines 3 sources and runs a transformation plugin)
```
## Code Example
```js
var RssBraider = require('rss-braider'),
feed_obj = {};
// Build feed options
feed_obj.filefeed = require("./config/feed").feed;
var braider_options = {
feeds : feed_obj,
indent : " ",
date_sort_order : "desc" // Newest first
};
var rss_braider = RssBraider.createClient(braider_options);
// braid 'filefeed' sources together and output in RSS format
rss_braider.processFeed('filefeed', 'rss', function(err, data){
if (err) {
return console.log(err);
}
console.log(data);
});
``` ```