Permalink
Browse files

Upaded README with installation instructions

  • Loading branch information...
1 parent cd63ff2 commit ddab63febd02c6cc1a706780c992f3487403b8d8 @jwood jwood committed Apr 23, 2012
Showing with 23 additions and 0 deletions.
  1. +23 −0 README.md
View
@@ -2,6 +2,29 @@
A simple library for working with the Proby task monitoring application.
+Installation
+------------
+
+### RubyGems ###
+ProbyNotifier can be installed using RubyGems
+
+ gem install proby_notifier
+
+Inside your script, be sure to
+
+ require "rubygems"
+ require "proby_notifier"
+
+### Bundler ###
+If you're using Bundler, add the following to your Gemfile
+
+ gem 'proby_notifier'
+
+and then run
+
+ bundle install
+
+
Setup
-----
Before notifications can be sent, you must tell ProbyNotifier your API key. This only needs to be done once,

0 comments on commit ddab63f

Please sign in to comment.