new (README.md): start providing simple documentation
This commit is contained in:
parent
3a9a59f3c5
commit
503a489da1
|
@ -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
|
Reference in New Issue