Added basic readme

README.rdoc

@@ -1,14 +1,33 @@
 = Munin-Rails-Plugins
+
 We are currently in the process of converting all the loose scripts into a gem.
 If you are looking for the loose scripts, please checkout https://github.com/barttenbrinke/munin-plugins-rails/tree/stable .
 
 This readme will be updated asap.
 
+Request-log-analyzer-munin, by Andrew Eberbach & Bart ten Brinke
+
+This gem automates munin-plugin scripts and configurations for monitoring of rails apps using the request-log-analyzer gem.
+* Simple
+* Low memory footprint and reasonably fast, so it is safe to run on a production server.
+
+== Installation & basic usage
+
+To install passenger plugins:
+  $ request-log-analyzer-munin install
+
+To install rails plugins:
+  $ request-log-analyzer-munin <app-name> <log-file>
+
+Examples:
+  $ request-log-analyzer-munin install
+  $ request-log-analyzer-munin MyAwesomeApp /srv/my_app/current/log/production.log
+
 Happy monitoring!
 
 == Additional information
 * Railsdoctors:         http://railsdoctors.com
 * Request-log-analzer:  http://github.com/wvanbergen/request-log-analyzer/
 * Screenshots           http://barttenbrinke.github.com/munin-plugins-rails/
 * Munin:                http://munin.projects.linpro.no/wiki/ConcisePlugins
-* License:              MIT
+* License:              MIT

bin/request-log-analyzer-munin

@@ -1,4 +1,29 @@
 #!/usr/bin/env ruby
 
+$:.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
 require 'munin-plugins-rails'
-Munin::Command.new.run(ARGV)
+
+if ARGV.length > 0
+  Munin::Command.new.run(ARGV)
+else
+  puts "Request-log-analyzer-munin, by Andrew Eberbach & Bart ten Brinke - version 0.2.10"
+  puts
+  puts "This gem automatates munin-plugin configurations for monitoring of rails apps using"
+  puts "the request-log-analyzer gem"
+  puts
+  puts "Usage: request-log-analyzer-munin [install|appname] <OPTIONS>"
+  puts
+  puts
+  puts "To install passenger plugins:"
+  puts "  request-log-analyzer-munin install"
+  puts
+  puts "To install railsplugins:"
+  puts "  request-log-analyzer-munin <app-name> <log-file>"
+  puts
+  puts "Examples:"
+  puts "  request-log-analyzer-munin install"
+  puts "  request-log-analyzer-munin MyAwesomeApp /srv/my_app/current/log/production.log"
+  puts
+  exit(0)
+end