From 666ea91e473554acabe6f6c3477eb915e70a7538 Mon Sep 17 00:00:00 2001
From: Nat Lasseter <nat.lasseter@york.ac.uk>
Date: Mon, 16 Mar 2020 10:15:21 +0000
Subject: Refactor: renamed jobs to raiders, becaus pun, and jobs is confusing
 given the intended application of longboat by the original authors.

---
 Readme.textile | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

(limited to 'Readme.textile')

diff --git a/Readme.textile b/Readme.textile
index d5f5f3a..7d993d5 100644
--- a/Readme.textile
+++ b/Readme.textile
@@ -2,17 +2,19 @@ h1. Longboat
 
 Longboat is a metric collection system. Intended for Viking, but theoretically generic.
 
-h2. Jobs
+h2. Raiders
 
-Longboat will pick up all jobs in the lib/jobs directory. Each job consists of:
+Raiders go out, raid things, and return to the longboat with metrics for the collector.
 
-* a file with a snake_case name, such as @my_job.rb@
+Longboat will pick up all raiders in the lib/raiders directory. Each raider consists of:
+
+* a file with a snake_case name, such as @my_raider.rb@
 * containing a single class with a CamelCase name matching the file name, such as @MyJob@
 * with two methods:
 ** @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
+*** a hash containing config relevant to raiders
+** @raid@, no arguments, which triggers a raid and metric report
 
 @Longboat::Collector#report!@ takes as arguments:
 
-- 
cgit v1.2.1

