🎨 Replace Sinfest filter with Kotlin version

[rhynodge.git] / README.md

diff --git a/README.md b/README.md
index 74d5cb0..32ebc3c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -12,16 +12,19 @@ Rhynodge’s configuration uses JSON files (I tried using XML first but apparent
 
 ## Running Rhynodge
 
-Rhynodge uses Maven as build and dependency management tool. Maven can also run 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
 
-> $ mvn clean compile exec:java
+> $ java -jar build/libs/rhynodge-all-*.jar
 
-Rhynodge accepts the following command-line parameters:
+Rhynodge accepts the following options using environment variables:
 
-- ``--chains <directory>``, ``-c <directory>``: directory to load chain configurations from.
-- ``--states <directory>``, ``-s <directory>``: directory to store states in.
+- ``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 directories need to be created before running Rhynodge.
+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.