summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 23 insertions, 29 deletions
diff --git a/README.md b/README.md
index 3d8e67e..d36ddb3 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,30 @@
+# Custodian
-Source:
- https://gitlab.bytemark.co.uk/open-source/custodian
+Custodian is a distributed protocol-tester written in portable Ruby,
+which can easily scale to covering the needs of a large network.
-Github Mirror:
- https://github.com/BytemarkHosting/custodian
+Here are some quick-links:
+* Source:
+ * https://gitlab.bytemark.co.uk/open-source/custodian
-Copyright:
- Copyright (c) 2012-2016 Bytemark Computer Consulting Ltd
+* Github Mirror:
+ * https://github.com/BytemarkHosting/custodian
-Bug Tracker:
- https://github.com/BytemarkHosting/custodian/issues
- https://gitlab.bytemark.co.uk/open-source/custodian/issues
+* Copyright:
+ * Copyright (c) 2012-2016 Bytemark Computer Consulting Ltd
-Licence:
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
+* Bug Tracker:
+ * https://github.com/BytemarkHosting/custodian/issues
+ * https://gitlab.bytemark.co.uk/open-source/custodian/issues
+* Licence:
+ * This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
-About Custodian
----------------
+
+## About Custodian
Custodian is a simple, scalable, and reliable protocol-tester that allows
a number of services to be tested across a network.
@@ -31,15 +32,11 @@ a number of services to be tested across a network.
The core design is based upon a work queue, which is manipulated by two
main tools:
- custodian-enqueue
- * A parser that reads a list of hosts and tests to apply. These
- tests are broken down into individual jobs, serialized and stored
- in a central queue.
-
- custodian-dequeue
- * A tool that pulls jobs from the queue, executing them in turn, and
- raises/clears alerts based upon the result of the test.
+* `custodian-enqueue`
+ * A parser that reads a list of hosts and tests to apply. These tests are broken down into individual jobs, serialized and stored in a central queue.
+* `custodian-dequeue`
+ * A tool that pulls jobs from the queue, executing them in turn, and raises/clears alerts based upon the result of the test.
Custodian uses class-factories to ensure that protocol tests, and notification
objects, are only loosely tied to the core. This is done so that custodian
@@ -47,8 +44,7 @@ may be extended or adapted more easily to your environment.
-Configuration
--------------
+## Configuration
The software is configured by the main configuration file located at:
@@ -61,9 +57,7 @@ Each of the available configuration options has a sensible default which
is documented in that same file.
-
-Dependencies
-------------
+## Dependencies
The software is written in Ruby and has successfully been deployed in
production under: