Edit feedreader documentation (#427)

This commit is contained in:
Alexander Fortin 2016-04-26 20:59:55 +02:00 committed by Fabian Affolter
parent 433c3ac10c
commit 385509c251

View File

@ -26,3 +26,25 @@ feedreader:
Configuration variables:
- **urls** (*Required*): List of URLS for your feeds.
Feedreader events can be used out of the box to trigger automation actions, e.g.:
```yaml
automation:
- alias: Trigger action when new element(s) in RSS feed
trigger:
platform: event
event_type: feedreader
action:
service: script.turn_on
entity_id: script.my_action
```
For more advanced use cases, a custom component registering to the `feedreader` event type could be used instead:
```python
EVENT_FEEDREADER = "feedreader"
hass.bus.listen(EVENT_FEEDREADER, event_listener)
```
To get started developing custom components, please refer to the [developers](/developers) documentation