aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md49
1 files changed, 44 insertions, 5 deletions
diff --git a/README.md b/README.md
index 75f2491..cf2d88a 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
# feed2imap-go
-A software to convert rss feeds into mails. feed2imap-go acts an an RSS/Atom feed aggregator. After downloading feeds
+A software to convert rss feeds into mails. feed2imap-go acts as an RSS/Atom feed aggregator. After downloading feeds
(over HTTP or HTTPS), it uploads them to a specified folder of an IMAP mail server. The user can then access the feeds
using their preferred client (Mutt, Evolution, Mozilla Thunderbird, webmail,...).
@@ -14,6 +14,8 @@ It aims to be compatible in functionality and configuration, and should mostly w
An example configuration can be found [here](config.yml.example).
+See [the Installation section](#installation) on how to install feed2imap-go. (Spoiler: It's easy ;)).
+
## Features
* Support for most feed formats. See [gofeed documentation](https://github.com/mmcdole/gofeed/blob/master/README.md#features)
@@ -28,7 +30,7 @@ for details.
### Additions to feed2imap
* groups (_details TBD_)
-* Heavier use of parallel processing (it's Go after all ;))
+* Heavier use of parallel processing (it's Go after all ;)). Also, it is way faster.
* Global `target` and each feed only specifies the folder relative to that target.
(feature contained also in [fork of the original][nec])
* Fix `include-images` option: It now includes images as mime-parts. An additional `embed-images` option serves the images
@@ -41,9 +43,8 @@ as inline base64-encoded data (the old default behavior of feed2imap).
* **Feed rendering**: Unfortunately, semantics of RSS and Atom tags are very broad. As we use a different feed parser
ibrary than the original, the interpretation (e.g., what tag is "the author") can differ.
-* **Caching**: We do not implement the caching algorithm of feed2imap point by point. In general we opted for less
-heuristics and more optimism (belief that GUID is filled correctly; belief that the difference between publishing and
-update date is adhered to). If this results in a problem, file a bug and include the `X-Feed2Imap-Reason` header of the mail.
+* **Caching**: We do not implement the caching algorithm of feed2imap point by point. In general, we opted for fewer
+heuristics and more optimism (belief that GUID is filled correctly). If this results in a problem, file a bug and include the `X-Feed2Imap-Reason` header of the mail.
* **Configuration**: We took the liberty to restructure the configuration options. Old configs are supported, but a
warning is issued when an option should now be in another place or is no longer supported (i.e., the option is without function).
@@ -52,8 +53,46 @@ 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
+* Planned for the nearer future: Text-Support ([issue #7][i7]): Currently, only HTML mails are produced.
+
+## Installation
+
+The easiest way of installation is to head over to [the releases page](https://github.com/Necoro/feed2imap-go/releases/latest)
+and get the appropriate download package. Go is all about static linking, thus for all platforms the result is a single
+binary which can be placed whereever you need.
+
+Please open an issue if you are missing your platform.
+
+### Install from source
+
+Clone the repository and, optionally, switch to the tag you want:
+````bash
+git clone https://github.com/Necoro/feed2imap-go
+git checkout v0.1.1
+````
+
+The official way of building feed2imap-go is using [goreleaser](https://github.com/goreleaser/goreleaser):
+````bash
+goreleaser --snapshot --rm-dist
+````
+The built binary is then inside the corresponding arch folder in `dist`.
+
+In case you do not want to install yet another build tool, doing
+````bash
+go build
+````
+should also suffice, but does not embed version information in the binary (and the result is slightly larger).
+
+If you are only interested in getting the latest build out of the `master` branch, do
+````bash
+go get https://github.com/Necoro/feed2imap-go
+````
+Note that this is not recommended, because it is a) not obvious which version you are actually building
+and b) the update process is not clear, especially regarding the dependencies.
+
[i6]: https://github.com/Necoro/feed2imap-go/issues/6
+[i7]: https://github.com/Necoro/feed2imap-go/issues/7
[i4]: https://github.com/Necoro/feed2imap-go/issues/4
[i9]: https://github.com/Necoro/feed2imap-go/issues/9
[nec]: https://github.com/Necoro/feed2imap