From aa4ababb52cba98eb27e8d67460db8dc610d475a Mon Sep 17 00:00:00 2001 From: Nat Lasseter Date: Mon, 16 Nov 2020 12:27:20 +0000 Subject: Add mention of examples to Readme --- Readme.textile | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Readme.textile b/Readme.textile index 8744307..8559de9 100644 --- a/Readme.textile +++ b/Readme.textile @@ -43,6 +43,8 @@ Raiders go out, raid things, and return to the longboat with metrics for the col Longboat will pick up all raiders in the @lib/raiders@ directory by default. +There are some example raiders in @examples@. + h3. Raider structure Each raider consists of: @@ -101,4 +103,4 @@ The @my_config hash will look like: bc. {:myraider_an_argument => true, :myraider_an_argument_given => true} -Be aware that there's no namespacing between raider arguments, so it's recommended that you prefix your argument with the raider's name, such as @--myraider-an-argument@. Also be aware that the automatic short-options are very likely to clash horribly, so try to avoid using these. Finally There is presently no way to get help about raider arguments. +Be aware that there's no namespacing between raider arguments, so it's recommended that you prefix your argument with the raider's name, such as @--myraider-an-argument@. Also be aware that the automatic short-options are very likely to clash horribly, so try to avoid using these. Finally, there is presently no way to get help about raider arguments. -- cgit v1.2.1