From: David ‘Bombe’ Roden Date: Tue, 19 Feb 2013 20:35:41 +0000 (+0100) Subject: Add paragraph about watchers. X-Git-Tag: 0.1~4 X-Git-Url: https://git.pterodactylus.net/?p=rhynodge.git;a=commitdiff_plain;h=a237607964d726df9d5f66cf708edbf682c524e8 Add paragraph about watchers. --- diff --git a/README.md b/README.md index 1a01145..7dcd717 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,12 @@ A trigger decides if, given the current state and the previous state, a notewort The result of a ``Trigger`` is an ``Output``. +### Watcher + +A watcher combines a query, a list of filters, and a trigger into a single unit which can be configured a lot easier than the separate components. For example, you could have a “Twitter” that finds new status updates for a username and that only needs to be configured with that username; the rest of the configuration is contained in the watcher. + +A ``Watcher`` does not do any processing but instead offers a ``Query``, a list of ``Filter``s, and a ``Trigger``. + ### Action If a trigger found a change, the action is then executed. Again, an action can be almost anything: it can send an email, it can execute programs, print documents, initiate phone calls, take a picture from a webcam — anything you can program can be used an an action.