Commit 54e2dde

mo khan <mo@mokhan.ca>
2014-11-11 22:35:20
update readme.
1 parent 50fdc6d
Changed files (1)
README.md
@@ -4,6 +4,9 @@
 
 Ooops... did I do that?
 
+The urkel gem is a client library that allows you to publish errors
+to an [urkel](https://github.com/mokhan/urkel-api) instance.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,11 +25,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+  # place in initializer
+  Urkel.configure do |configuration|
+    configuration.api_host = 'http://localhost:3000'
+    configuration.api_key = '02513a35-b875-40a1-a1fc-f2d2582bdcc5'
+  end
+
+  # usage
+  begin 
+    0/1
+  rescue StandardError => error
+    Urkel.oops(error)
+  end
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/urkel/fork )
+1. Fork it ( https://github.com/mokhan/urkel/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)