Documentation

3 files changed, 10 insertions, 4 deletions

diff --git a/CHANGELOG.md b/CHANGELOG.md
index e93cfb5..d9b6634 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Verbose variant of 'target' in config: Do not hassle with urlencoded passwords anymore!
 - New feed option 'item-filter' for filtering out specific items from feed.
+- New feed option 'exec', allowing to specify a command to execute instead of a Url to fetch from.
 
 ## [0.3.1] - 2020-05-12
 - Docker Setup
diff --git a/README.md b/README.md
index 4ba089d..f1fa3f7 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ It also includes the features that up to now only lived on [my own branch][nec].
 It aims to be compatible in functionality and configuration, and should mostly work as a drop-in replacement 
 (but see [Changes](#changes)).
 
-An example configuration can be found [here](config.yml.example).
+An example configuration can be found [here](config.yml.example) with additional information in the [wiki](https://github.com/Necoro/feed2imap-go/wiki/Detailed-Options).
 
 See [the Installation section](#installation) on how to install feed2imap-go. (Spoiler: It's easy ;)).
 
@@ -38,6 +38,7 @@ as inline base64-encoded data (the old default behavior of feed2imap).
 * Improved image inclusion: Support any relative URLs, including `//example.com/foo.png`
 * Use HTML-Parser instead of regular expressions for modifying the HTML content.
 * STARTTLS-Support. As it turned out only in testing, the old feed2imap never supported it...
+* `item-filter` option that allows to specify an inline filter expression on the items of a feed.
 
 ### Subtle differences
 
@@ -52,7 +53,6 @@ warning is issued when an option should now be in another place or is no longer
 
 * IMAP-Target per Feed ([issue #6][i6]); targets only specify the folder relative to the global target
 * Maildir ([issue #4][i4])
-* Scripts for generating/filtering feeds
 
 ## Installation
 
diff --git a/config.yml.example b/config.yml.example
index 0e0e304..1213189 100644
--- a/config.yml.example
+++ b/config.yml.example
@@ -70,9 +70,12 @@ options:
   # If an item is updated, but has been deleted on the server already, it is re-uploaded when this option is true.
   # Else it is ignored.
   reupload-if-updated: false
+  # Items of a feed may be filtered. In general there is no real use in specifying this globally.
+  # For full information about this feature, visit https://github.com/Necoro/feed2imap-go/wiki/Detailed-Options.
+  item-filter: 'Author.Name != "Weirdo"'
 
 ## Feeds
-# Each feed must have a name and a URL. The name must be unique.
+# Each feed must have a name, and a URL or Exec argument. The name must be unique.
 # The name also determines the folder to use for that feed, which can be overwritten with an explicit target.
 # Groups can be used to build a hierarchy, with arbitrary nesting.
 feeds:
@@ -91,7 +94,9 @@ feeds:
         # Considering the global `target` the final folder will be:
         #  INBOX/Feeds/Linux/Arch
         target: Arch
-        url: https://www.archlinux.org/feeds/news/
+        # Use `exec` instead of `url` when fetching is not enough and script magic is needed.
+        # See https://github.com/Necoro/feed2imap-go/wiki/Detailed-Options for details.
+        exec: ["wget", "https://www.archlinux.org/feeds/news/", "-O", "-"]
         # Groups can be nested...
       - group: Gentoo
         # and also specify a target (which is superfluous here, because it is identical to the group name)