readme: add demo screenshot

This commit is contained in:
A.M. Rowsell 2026-04-25 22:47:37 -04:00
commit a34cc1ac8e
Signed by: amr
GPG key ID: E0879EDBDB0CA7B1

View file

@ -13,6 +13,10 @@ feedparser
The remaining imports should all be part of the standard Python install: hashlib, logging, asyncio, pathlib, json, time, os, sys, argparse, re, types. To install the required ones, use your distro's package manager -- don't use pip unless you want to run the entire script in a virtualenv (which would probably make the systemd unit file a bit more complex, I think you'd have to add a PreExec to activate the virtualenv and a PostExec to disable it?).
<p align="center">
![DiscoRSS Demo Screenshot](https://frzn.dev/~amr/images/Screenshot_224228_1.png)
</p>
## Important Notes
By default, DiscoRSS will try and put the logs in `/var/log/discorss`. Make sure to create this directory and give the user running the script write permissions there. If you want the logs to go somewhere else, just give the path as an argument (shown below). Choose a directory that makes sense. Unfortunately, as far as I know, the XDG standards don't have an equivalent to the /var/log directory in the user directory, so I wasn't sure what the best default was. In the future, we may switch to logging using systemd and journald directly, though it is nice to have a separate file.