Outils-PeerTube/peertube-listener-rss
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

edit readme

Browse Source
This commit is contained in:
Amaury Joly 2021-03-28 22:50:13 +02:00
parent 603aa0f2a1
commit 8ddb0f1817
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,2 +1,27 @@
# peertube-listener-rss
An easy way to configure and manage a listener with the peertube rss service.
## Doc
### constructor(adrInstance, idChaine ,timeloop? ,lastEntriesLinks?)
#### adrInstance : string
This is the url pointing to the desired instance. For exemple if your rss feed as a link like : `https://skeptikon.fr/feeds/videos.xml?videoChannelId=3704` the adrInstance should be `skeptikon.fr` .
#### idChaine : string
This is the channel ID of the target peertube channel.
#### timeloop : number [optional]
This is the time in seconds who's wait beetween each updates. (default 300).
#### lastEntriesLinks : string[] [optional]
This is an easy way to set the historical and manage the newEntries event.
### More infos
This is an specification of the [listener-rss package](https://zeteo.me/gitea/Outils-PeerTube/listener-rss). So we'are provide a custom constructor to create a listener with just the channel ID and the adress instance. To have some others infos and features let's check this repository : https://zeteo.me/gitea/Outils-PeerTube/listener-rss .