README: Explain how email delivery works wrt. projects

Without looking at the code, it may not be entirely obvious that we may
need a custom hook just to print X-Aiaiai-Project and avoid the need for
per-project email addresses.

Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>

diff --git a/doc/README b/doc/README
index 9ec12540a79cb25127bae5ecf346e725bac56786..18be35bc1a7de1187656291e0a83f7a122f28fa1 100644 (file)
--- a/doc/README
+++ b/doc/README
@@ -130,6 +130,15 @@ $ cat /home/aiaiai/bin/my-aiaiai-lda
 aiaiai-email scripts use a common configuration file, which is documented in
 doc/email/example-aiaiai.cfg
 
+By default aiaiai expects email targeting a specific project to be delivered to
+a specific aiaiai recipient address which includes it, e.g:
+aiaiai+foo@domain.tld.
+
+In case you would want to use the same aiaiai recipient email address for all
+projects, you need to create a hook file which will be looking at the
+X-Aiaiai-Project header in the mbox file, and output it to stdout (see:
+email/aiaiai-email-test-patchset)
+
 1.3 Non-e-mail scripts
 ~~~~~~~~~~~~~~~~~~~~~~