Example config: "Show Me Everything"

doc/examples.md

@@ -57,3 +57,46 @@ a private message.
   private message, a notification is only sent if the user has not yet received
   a notification for that context, or if they have gotten a notification and
   have since responded to that context.
+
+
+Show Me Everything
+------------------
+
+Sometimes you just want to see everything.  More is better.  You want ZNC Push
+to work more like Colloquy or Growl.  You want a push notification every single
+time you get mentioned, and every time you get a private message.  And maybe
+you don't care about nickserv.
+
+That's easy!
+
+### Configuration
+
+    channel_conditions: highlight and nick_blacklist
+    query_condition: nick_blacklist
+
+    nick_blacklist: nickserv
+
+### Explanation
+
+By overriding `channel_conditions` and `query_conditions`, you're telling
+ZNC Push that you only care about a specific set of checks when sending
+notifications, and that you want to ignore the rest.
+
+Both of these options are [boolean expressions][booleans], which evaluate to
+either true or false.  If it evaluates to true, then a notification is sent.
+By specifying `highlight and nick_blacklist`, you're telling ZNC Push that
+only those two conditions must be true in order to send a notification.
+
+In this case, `highlight` is true for any message that includes either your
+nick, or a word that's listed in your configured value for the `highlight`
+option.  Similarly, `nick_blacklist` is true for any message that *isn't* sent
+by a user that's listed in your configured value for the `nick_blacklist`
+option.  Since highlight is relatively meaningless for private messages,
+it can safely be left out of `query_conditions`, leaving just `nick_blacklist`.
+
+The result of this example is that you'll receive a push notification for each
+and every private message -- that doesn't come from nickserv -- and every time
+you get mentioned in a channel by someone who isn't nickserv.
+
+
+[booleans]: https://en.wikipedia.org/wiki/Boolean_expression