aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2022-02-16 16:55:44 -0500
committerJesse Luehrs <doy@tozt.net>2022-02-16 16:55:44 -0500
commitbdc6e8b59228511d6cc22d016fd960066822377c (patch)
tree9ca37e89b2f4ce9cd5987a0b926e7d3a2a69f3c4 /README.md
parenta383ba7a8d3965b74d90c1ad0ed0647f43ae1c3e (diff)
downloadmbsyncloop-bdc6e8b59228511d6cc22d016fd960066822377c.tar.gz
mbsyncloop-bdc6e8b59228511d6cc22d016fd960066822377c.zip
add installation instructionsHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4aceeaf..715131a 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,11 @@ simplest, it just runs in a loop which fetches all mail every 15 minutes, but
it can be configured to watch some or all mailboxes using IMAP IDLE to
immediately trigger mail fetching as it comes in.
+## Installation
+
+`mbsyncloop` is a standalone script, it just needs to be somewhere on your
+`$PATH`. It requires `perl`, `mbsync`, and `goimapnotify` to be installed.
+
## Configuration
Configuration is read from `~/.config/mbsyncloop/config.json` if available. All