🎨 Replace test for HeldentageFilter with Kotlin version

[rhynodge.git] / README.md

diff --git a/README.md b/README.md
index da01243..32ebc3c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,6 +6,28 @@ Rhynodge is a tool that lets you periodically execute tasks that depend on certa
 
 Its concept is quite similar to websites like ifttt (“if this then that”): you evaluate an input condition (e. g. data from a website, Facebook or Twitter posts, incoming emails, existence of a file), and if it evaluates to “yes” you execute a certain action.
 
+## Configuration
+
+Rhynodge’s configuration uses JSON files (I tried using XML first but apparently polymorphic deserialization is something that is not easily done with XML parsers). The format of a ``Chain`` configuration is pretty straight-forward and can be seen in the example configuration files.
+
+## Running Rhynodge
+
+Rhynodge uses Gradle as build and dependency management tool. After creating a “fat jar” (a JAR file containing all required dependencies), simply run the jar file with
+
+> $ java -jar build/libs/rhynodge-all-*.jar
+
+Rhynodge accepts the following options using environment variables:
+
+- ``SMTP_HOSTNAME``: the hostname of the SMTP server, is used for error emails; default is “localhost”
+- ``ERROR_EMAIL_SENDER``: the email address to use as sender for error emails
+- ``ERROR_EMAIL_RECIPIENT``: the email address to send error emails to
+- ``CHAIN_DIRECTORY``: directory to load chain configurations from; default is “chains”
+- ``STATE_DIRECTORY``: directory to store states in; default is “states”
+
+Both chain and state directories need to be created before running Rhynodge.
+
+Rhynodge also periodically scans the chains directory to find changed or new chain configuration files. New files will be added to the running instance, changed files will be reloaded, and removing files will remove the corresponding job from Rhynodge.
+
 ## Internal Concepts
 
 The core of Rhynodge comprises ``Reaction``s which in turn consist of ``Query``s, ``Filter``s, ``Trigger``s, and ``Action``s.
@@ -37,7 +59,3 @@ A ``Watcher`` does not do any processing but instead offers a ``Query``, a list
 ### 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.
-
-## Configuration
-
-Rhynodge’s configuration uses JSON files (I tried using XML first but apparently polymorphic deserialization is something that is not easily done with XML parsers). The format of a ``Chain`` configuration is pretty straight-forward and can be seen in the example configuration files.