From 4f962ce9038af986b06ed0bc1d3166f1b107ef26 Mon Sep 17 00:00:00 2001 From: Torgny Bjers Date: Mon, 11 Oct 2021 18:30:06 -0600 Subject: [PATCH] add explanation for plugin --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 5aa98e9..a566ee7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ A plugin that checks mail asynchronously, giving you feedback through the process via notifications. +This plugin was mostly written to accomodate running [mbsync](https://isync.sourceforge.io/mbsync.html) from inside `alot` without being intrusive. This can be useful if you do not wish to wait for your systemd timer to execute your mail sync. + ## Installation Run the following in the environment that alot's `hooks.py` uses: