X-Git-Url: https://git.pterodactylus.net/?p=rhynodge.git;a=blobdiff_plain;f=README.md;h=7dcd717f2b75ab3a12775e742dcddcf29bcd2576;hp=1a011458a5173faf3cb9a5f1e9e1cc23b1abb1dd;hb=a237607964d726df9d5f66cf708edbf682c524e8;hpb=11dfcd344c860bd34cf0ca5ee498a8a4f38d1538 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.