From 60ccb8e30e4542d54702dcba16940b4a341cf644 Mon Sep 17 00:00:00 2001
From: Jim Myhrberg <contact@jimeh.me>
Date: Fri, 3 Feb 2012 12:39:51 +0000
Subject: [PATCH] added readme

---
 README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dda6123
--- /dev/null
+++ b/README.md
@@ -0,0 +1,62 @@
+# Airbrake-Statsd
+
+Extends the [Airbrake][] gem to also report exceptions Esty's [Statsd][]
+statistics aggregator.
+
+## Installation
+
+    gem install airbrake-statsd
+
+## Usage
+
+It's assumed you know what both Airbrake and StatsD are before attempting to
+use this gem. If you don't, come back when you do know :)
+
+All that's needed is to require `airbrake-statsd` and call
+`Airbrake::Statsd.configure` and Airbrake notifications will automatically be
+sent to StatsD and Airbrake.
+
+```ruby
+require 'airbrake'
+require 'airbrake-statsd'
+
+Airbrake::Statsd.configure do |config|
+  config.host = 'my-statsd-server'
+  config.port = 8125
+  config.namespace = 'my_awesome_app'
+end
+
+Airbrake.notify({})
+```
+
+## Credit & Thanks
+
+* [Global Personals][gp] for hosting a hack day.
+
+## License and Copyright
+
+Copyright (c) 2011 Jim Myhrberg & Global Personals, Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+[airbrake]: http://airbrake.io/
+[statsd]: https://github.com/etsy/statsd
+[gp]: http://globalpersonals.co.uk/