aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRené 'Necoro' Neumann <necoro@necoro.eu>2022-01-08 21:09:00 +0100
committerRené 'Necoro' Neumann <necoro@necoro.eu>2022-01-08 21:09:00 +0100
commiteb902458bc77067532d6ecc4754fd6993ec24af2 (patch)
tree77abedab288d648408457ed920883572a832ae09
parentea115e8bb1145e20ec25d8e1954427244c250a10 (diff)
downloadfeed2imap-go-eb902458bc77067532d6ecc4754fd6993ec24af2.tar.gz
feed2imap-go-eb902458bc77067532d6ecc4754fd6993ec24af2.tar.bz2
feed2imap-go-eb902458bc77067532d6ecc4754fd6993ec24af2.zip
#67: Update documentation
-rw-r--r--CHANGELOG.md3
-rw-r--r--README.md3
-rw-r--r--config.yml.example2
3 files changed, 7 insertions, 1 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e44d90a..53fc5d5 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
+### Added
+- [Issue #67](https://github.com/Necoro/feed2imap-go/issues/67): Support for fetching the linked article/website instead of using the body in the feed (configuration: `body: fetch`). This is especially useful when the feed only supplies links/teaser and not the full content.
+
## [1.4.0] - 2021-12-21
### Added
- Make links absolute: relative links inside a feed cannot be resolved outside a webbrowser (Example/culprit: https://go.dev/blog/go1.18beta1)
diff --git a/README.md b/README.md
index 3ea36d0..6b424c1 100644
--- a/README.md
+++ b/README.md
@@ -40,6 +40,7 @@ as inline base64-encoded data (the old default behavior of feed2imap).
* 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.
+* Readability support: Fetch and present the linked article.
### Subtle differences
@@ -68,7 +69,7 @@ Please open an issue if you are missing your platform.
Clone the repository and, optionally, switch to the tag you want:
````bash
git clone https://github.com/Necoro/feed2imap-go
-git checkout v1.2.0
+git checkout v1.4.0
````
The official way of building feed2imap-go is using [goreleaser](https://github.com/goreleaser/goreleaser):
diff --git a/config.yml.example b/config.yml.example
index 1c51b6b..136d890 100644
--- a/config.yml.example
+++ b/config.yml.example
@@ -65,6 +65,8 @@ options:
# - content: Use the 'content' tag
# - description: Use the 'description' tag
# - both: Use both
+ # - fetch: Ignore the body delivered by the feed and instead fetch the linked website.
+ # It may be advisable to set `include-images` to false in that mode to avoid unexpected large mails.
body: default
# Disable a feed. Beats commenting ;)
disable: false