README.md in uptime_monitor-0.3.1 vs README.md in uptime_monitor-0.3.2
- old
+ new
@@ -4,10 +4,12 @@
[![Gem Version](https://badge.fury.io/rb/uptime_monitor.svg)](http://badge.fury.io/rb/uptime_monitor)
Uptime_monitor is a [ragios](https://github.com/obi-a/ragios) plugin that uses a real web browser to perform transactions on a website to ensure that features of the site are still working correctly. It can check elements of a webpage to ensure they still exist and it can also perform transactions like a website login to ensure that the process still works correctly.
##Requirements
+Ruby: At least Ruby 2.3.0 or higher is recommended
+
[Ragios](https://github.com/obi-a/ragios)
##Installation:
Add the uptime_monitor gem to your ragios Gemfile
```ruby
@@ -21,25 +23,32 @@
```ruby
require 'uptime_monitor'
```
Restart ragios
-##usage:
+##Run in a Docker Container
+(Optional) A docker container is available with the uptime_monitor plugin and all its dependencies already setup and configured. You can run it out of the box with minimal effort in this docker container. See details here: [Using Maestro](https://github.com/obi-a/maestro).
+
+##Usage:
A quick example, to monitor the title tag of a web page to ensure that it hasn't changed. Using [Ragios ruby client](http://www.whisperservers.com/ragios/ragios-saint-ruby/using-ragios)
````ruby
monitor = {
monitor: "My Blog title tag",
url: "http://obi-akubue.org",
every: "5m",
contact: "admin@obiora.com",
via: "gmail_notifier",
plugin: "uptime_monitor",
- exists?: 'title.with_text("Obi Akubue")'
+ exists?: 'title.with_text("Obi Akubue")',
browser: "firefox"
}
ragios.create(monitor)
```
-The above example will create a ragios monitor that will, every 5 minutes, use firefox to visit the website url http://obi-akubue.org, and verify that the home page title tag matches the text "Obi Akubue". The validations performed as defined in the exists? key/value pair. When the title tag doesn't match the text, a failure notification will be sent out to the provided contact "admin@obiora.com".
+The above example will create a ragios monitor that will, every 5 minutes, use firefox to visit the website url http://obi-akubue.org, and verify that the home page title tag matches the text "Obi Akubue". The validations performed are defined in the exists? key/value pair, in this statement.
+```ruby
+exists?: 'title.with_text("Obi Akubue")'
+```
+When the title tag on the web page doesn't match the text "Obi Akubue", a failure notification will be sent out to the provided contact "admin@obiora.com".
###Using the plugin
To use the uptime monitor plugin add the key/value pair to the monitor
```ruby
plugin: "uptime_monitor"