aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGuilhem Moulin <guilhem@fripost.org>2020-05-12 16:42:25 +0200
committerGuilhem Moulin <guilhem@fripost.org>2020-05-12 16:51:15 +0200
commitd97e6ca072b3577d21f6136dbded5fd991fd4317 (patch)
treecdca40c74c9dc32822629716827d43fdf8168e88 /doc
parentea57a0ab32b0863cfa1209423a5b4c8dd195f803 (diff)
index: Add a short summary to the index.
Per Stefan Kangas' suggestion.
Diffstat (limited to 'doc')
-rw-r--r--doc/index.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/index.md b/doc/index.md
index d475592..4dd72f1 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -1,18 +1,32 @@
% InterIMAP & PullIMAP
% [Guilhem Moulin](mailto:guilhem@fripost.org)
+InterIMAP synchronizes emails and their metadata between a remote IMAP
+server and local storage. By leveraging the [*Quick Mailbox
+Resynchronization*][RFC 7162] IMAP extension, it can offer [*much better
+performance*](benchmark.html) than tools such as [OfflineIMAP].
+
+PullIMAP retrieves messages from an IMAP mailbox and deliver them
+locally. It can use the the [*IDLE*][RFC 2177] IMAP extension to reduce
+both latency and network traffic.
+
+[RFC 2177]: https://tools.ietf.org/html/rfc2177
+[RFC 7162]: https://tools.ietf.org/html/rfc7162
+[OfflineIMAP]: https://www.offlineimap.org/
+
General documentation
---------------------
* [Getting started with InterIMAP](getting-started.html)
* [Multi-remote setup for InterIMAP](multi-account.html)
* [InterIMAP benchmark metrics and comparison](benchmark.html)
+ * [Presentation at DebConf19](https://debconf19.debconf.org/talks/78-interimap-the-case-for-local-imap-servers-and-fast-bidirectional-synchronization/)
Manuals (HTML versions)
-----------------------
* [`interimap`(1)](interimap.1.html) — Fast bidirectional
- synchronization for QRESYNC-capable IMAP servers
+ synchronization for IMAP servers
* [`pullimap`(1)](pullimap.1.html) — Pull mails from an IMAP mailbox
and deliver them to an SMTP session