From 3016dab0b4947b924ae4c517660c6321bf5a9ad4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20Hells=C3=A9n?= Date: Fri, 31 Dec 2021 04:12:01 +0100 Subject: [PATCH] Update README --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 49f1bdb..126b323 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ # discord-rss-bot -A RSS bot for Discord + +A RSS bot for Discord built with [reader](https://github.com/lemon24/reader). It is designed to be executed by a [cron job](https://wiki.archlinux.org/title/Cron) or [systemd timer](https://wiki.archlinux.org/title/Systemd/Timers). + + Usage: discord_rss_bot.py [OPTIONS] COMMAND [ARGS]... + + Options: + --install-completion Install completion for the current shell. + --show-completion Show completion for the current shell, to copy it or customize the installation. + --help Show this message and exit. + + Commands: + add Add a feed to the database + backup Backup the database + check Check new entries for every feed + delete Delete a feed from the database + stats Print the number of feeds and entries in the database + webhook-add Add a webhook to the database + webhook-get Get the webhook url