From 8ddb0f181735e8ec98aa2a958c627a84effce4e1 Mon Sep 17 00:00:00 2001 From: Amaury Joly Date: Sun, 28 Mar 2021 22:50:13 +0200 Subject: [PATCH] edit readme --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index d61338c..c14baf6 100644 --- a/README.md +++ b/README.md @@ -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 .