Update README to explain when mentions are sent
authorKyle Fuller <redacted>
Thu, 14 Mar 2013 07:55:02 +0000 (07:55 +0000)
committerKyle Fuller <redacted>
Thu, 14 Mar 2013 10:53:59 +0000 (10:53 +0000)
README.md

index e2f8b9d15b2866fbd9a0ad152a2e871fb28cd217..8ba3a4b75ce26b12edad7f12ab0bfa062916a73d 100644 (file)
--- 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.
+
git clone https://git.99rst.org/PROJECT