summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorSteve Kemp <steve@steve.org.uk>2015-02-18 06:50:11 +0000
committerSteve Kemp <steve@steve.org.uk>2015-02-18 06:50:11 +0000
commite5409a45b414f7fdc637ddc73cb6ca82aa3da083 (patch)
treeea517ac271ea7f9914d7ce0268810d5aaa429ecc /README
parent1665312661bc789edec360dc9bbdac990b3c2abf (diff)
Moved the list of dependencies to the README file.
We only have two dependencies: * The curb-gem for HTTP-testing. * A queue-related gem, be it beanstalkd or redis.
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 16 insertions, 0 deletions
diff --git a/README b/README
index cd457b8..26cb2f7 100644
--- a/README
+++ b/README
@@ -61,6 +61,22 @@ is documented in that same file.
+Dependencies
+------------
+
+The software is written in Ruby and will work under either Ruby 1.8,
+or Ruby 1.9.1. The software has not yet been tested upon Ruby 2.x, JRuby,
+or similar.
+
+Dependencies, beyond ruby, are limited to the following gems:
+
+* For HTTP/HTTPS testing: curb
+* For communication with the queue: redis / beanstalkd-client
+
+You may install either redis or beanstalkd as your queue, and install
+the corresponding gem. There is no need to install both.
+
+
Documentation
-------------