From: Kyle Fuller <redacted>
Date: Thu, 14 Mar 2013 07:55:02 +0000 (+0000)
Subject: Update README to explain when mentions are sent
X-Git-Tag: 1.0.0~32
X-Git-Url: http://git.99rst.org/?a=commitdiff_plain;h=6179c1e77c6b4e71a64af5afb79d6f2662c57d29;p=znc-palaver.git

Update README to explain when mentions are sent
---

diff --git a/README.md b/README.md
index e2f8b9d..8ba3a4b 100644
--- a/README.md
+++ b/README.md
@@ -16,3 +16,15 @@ Now load the ZNC module:
 
     /msg *status loadmod palaver
 
+##  When will I get notifications?
+
+You will be mentioned when any of the following rules are met:
+
+* You get a private message directly to you.
+* Any message which includes your current nickname.
+* A message contains a mention keyword from the mention keywords in `Settings > Mentions`
+
+Notifications will only be sent if all your clients are disconnected, or marked
+as away. You can use the [clientaway](http://wiki.znc.in/Clientaway) module to
+mark a connected client as away.
+