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

More README

Browse Source
This commit is contained in:
Kip Gebhardt 2015-06-11 17:15:45 -07:00
parent 7aeed75a4e
commit 67bd0a78eb
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -65,7 +65,9 @@ rss_braider.processFeed('simple_test_feed', 'rss', function(err, data){
}); });
``` ```
## Plugins ## Plugins
Plugins provide custom manipulation and filtering of RSS items/articles. See `lib/example_plugins` for examples. A plugin operates by modifying the itemOptions object or by returning `null` which will exclude the `item` (article) from the resulting feed. Plugins provide custom manipulation and filtering of RSS items/articles. See `examples/plugins` for examples.
A plugin operates by modifying the itemOptions object or by returning `null` which will exclude the `item` (article) from the resulting feed (See `examples/plugins/filter_out_all_articles.js`).
### Plugin Example ### Plugin Example
This plugin will capitalize the article title for all articles This plugin will capitalize the article title for all articles
@ -75,7 +77,6 @@ module.exports = function (item, itemOptions, source) {
return; return;
} }
if (itemOptions.title) { if (itemOptions.title) {
itemOptions.title = itemOptions.title.toUpperCase(); itemOptions.title = itemOptions.title.toUpperCase();
} }
@ -84,4 +85,11 @@ module.exports = function (item, itemOptions, source) {
}; };
``` ```
The plugin is registered with the feed in the feed config .js file and are run in order.
```js
var feed = {
"feed_name" : "feed with plugins",
"default_count" : 1,
"plugins" : ['capitalize_title', 'plugin_template'],
...
```