From ab6e28417a9195fe03b8355a808a81276d0435ff Mon Sep 17 00:00:00 2001
From: Nat Lasseter <nat.lasseter@york.ac.uk>
Date: Tue, 3 Mar 2020 14:25:32 +0000
Subject: Added command line config

---
 Readme.textile | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'Readme.textile')

diff --git a/Readme.textile b/Readme.textile
index aa4750d..d5f5f3a 100644
--- a/Readme.textile
+++ b/Readme.textile
@@ -9,7 +9,9 @@ Longboat will pick up all jobs in the lib/jobs directory. Each job consists of:
 * a file with a snake_case name, such as @my_job.rb@
 * containing a single class with a CamelCase name matching the file name, such as @MyJob@
 * with two methods:
-** @initialize@, which takes a single argument of the collector to @report!@ the metrics to
+** @initialize@, which takes two arguments of:
+*** the collector to @report!@ the metrics to, and
+*** a hash containing config relevant to jobs
 ** @run@, no arguments, which triggers a job run and metric report
 
 @Longboat::Collector#report!@ takes as arguments:
-- 
cgit v1.2.3

