Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/flipez/hubot-rss-rolf

RSS Reader on Hubot
https://github.com/flipez/hubot-rss-rolf

hubot hubot-rss hubot-script hubot-scripts rocketchat rocketchat-hubot rss

Last synced: 1 day ago
JSON representation

RSS Reader on Hubot

Awesome Lists containing this project

README

        

Hubot RSS Reader
================
RSS Reader for each Chat Channels, works with Hubot.

[![npm version](https://badge.fury.io/js/hubot-rss-rolf.svg)](https://badge.fury.io/js/hubot-rss-rolf)

- https://github.com/Flipez/hubot-rss-rolf
- https://www.npmjs.org/package/hubot-rss-rolf

![screen shot](http://gyazo.com/234dfb14d76bb3de9efd88bfe8dc6522.png)

Requirements
------------

- hubot-brain
- recommend [hubot-redis-brain](https://github.com/hubotio/hubot-redis-brain).

Install
-------

% npm install hubot-rss-rolf -save

### edit `external-script.json`

```json
["hubot-rss-rolf"]
```

### Configure (ENV vars)

export DEBUG=hubot-rss-reader* # debug print
export HUBOT_RSS_INTERVAL=600 # 600 sec (default)
export HUBOT_RSS_HEADER=:sushi: # RSS Header Emoji (default is "sushi")
export HUBOT_RSS_USERAGENT=hubot # (default is "hubot-rss-reader/#{package_version}")
export HUBOT_RSS_PRINTSUMMARY=true # print summary (default is "true")
export HUBOT_RSS_PRINTIMAGE=false # print image in summary (default is "true")
export HUBOT_RSS_PRINTMARKDOWN=true # use markdown message (default is "false")
export HUBOT_RSS_PRINTERROR=false # print error message (default is "true")
export HUBOT_RSS_IRCCOLORS=true # use IRC color message (default is "false")
export HUBOT_RSS_LIMIT_ON_ADD=false # limit printing entries on add new feed. (default is 5)
export HUBOT_RSS_DUMP_USERS="" # limit dump to special user (list without spaces eg. "user1,user2")

Usage
-----

### add

hubot rss add https://github.com/Flipez.atom
# or
hubot rss register https://github.com/Flipez.atom

### delete

hubot rss delete https://github.com/Flipez.atom
hubot rss delete #room_name (only within the room or for users in HUBOT_RSS_DUMP_USERS list)

### list

hubot rss list
hubot rss dump (only for users in HUBOT_RSS_DUMP_USERS list)

## About

This project was forked from [hubot-rss-reader](https://github.com/shokai/hubot-rss-reader)
from [shokai](https://github.com/shokai) with the fix from [yynozk](https://github.com/yynozk)
and published as [hubot-rss-rolf](https://www.npmjs.com/package/hubot-rss-rolf) to make it useable for rocketchat again.