From 503a489da1e5b545a1bf33a49fd047e8a4670554 Mon Sep 17 00:00:00 2001 From: eeemsi Date: Sat, 4 Feb 2023 15:48:09 +0100 Subject: [PATCH] new (README.md): start providing simple documentation --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..535a2fb --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Motivation + +A script to automatically mark entires as read in miniflux using its api + +# How to use + +## config file + + [options] + # instance of miniflux + url=https://example.com + + # generated token from miniflux + token=??????????????????????????????????????????? + + # age of entries that should be marked as read + age=86400 + + # categories that should be ignored (entries will not be marked as read) + ignore=audio & video + +## systemd service + + [Unit] + Description=mark certain entries as read in miniflux + + [Service] + Type=oneshot + ExecStart=/usr/bin/env python3 ./mark_as_read.py --config ./mark_as_read.ini + +## systemd timer + + [Unit] + Description=mark certain entries as read in miniflux + + [Timer] + OnCalendar=daily + + [Install] + WantedBy=timers.target