commit 78dc66cd0d71ff71e3c936026ff6e5ee723724f8
from: witcher <witcher@wiredspace.de>
date: Mon Aug 15 11:13:19 2022 UTC

Add README.md

commit - c7665c29c257f354af8ca7b00f99f89c2a459f48
commit + 78dc66cd0d71ff71e3c936026ff6e5ee723724f8
blob - /dev/null
blob + fc6fa7d0e8b13276f78ae6d6173d35d71553a977 (mode 644)
--- /dev/null
+++ README.md
@@ -0,0 +1,37 @@
+# rss-email
+
+Fetch new RSS feed items and send them via E-Mail.
+
+## Compiling
+
+Install the dependencies:
+
+- Rust
+
+Then compile rss-email:
+
+```
+cargo build
+```
+
+## Usage
+
+- Copy the `config.example.toml` to `~/rss-email/config.toml` and adjust the
+values
+- Create a `urls` file at `~/rss-email/urls` with one RSS url per line
+
+The database used with `rss-email` is generated automatically if it doesn't exist
+yet
+
+See `-h` for more info.
+
+## Resources
+
+Send patches and questions to
+[~witcher/public-inbox@lists.sr.ht](https://lists.sr.ht/~witcher/public-inbox).
+
+Instructions for preparing a patch are available at
+[git-send-email.io](https://git-send-email.io/).
+
+Bugs and todo can be found at
+[~witcher/rss-email](https://todo.sr.ht/~witcher/rss-email).