README.md in hydraulic_brake-0.1.0 vs README.md in hydraulic_brake-0.2.0

- old
+ new

@@ -1,7 +1,6 @@ -HydraulicBrake -======== +# HydraulicBrake [![Build Status](https://travis-ci.org/stevecrozz/hydraulic_brake.svg?branch=master)](https://travis-ci.org/stevecrozz/hydraulic_brake) This is a replacement notifier gem for the [Airbrake gem](https://github.com/airbrake/airbrake) which is used for integrating ruby apps with [Airbrake](http://airbrake.io). @@ -74,14 +73,25 @@ HydraulicBrake#notify. Async Notifications ------------------- -HydraulicBrake doesn't provide anything special for async notifications. -Just wrap your calls to Airbrake#notify in the async library of your -choice if you want to. +HydraulicBrake can send notifications for you in the background using a Ruby +thread. If configured for async notifications, calls to HydraulicBrake::Notify +will populate an in-memory queue up to a configurable limit. If you reach the +limit, HydraulicBrake will send an error to HydraulicBrake.logger for every +additional notice beyond the queue's capacity and this notice will contain +information about the notice that could not be sent. Shown below are the +default options, but you may adjust them to suit your needs. +```ruby +HydraulicBrake.configure do |config| + config.async = false + config.async_queue_capacity = 100 +end +``` + Proxy Support ------------- The notifier supports using a proxy. To configure a proxy, add the configuration to HydraulicBrake#configure: @@ -92,36 +102,20 @@ config.proxy_port = 4038 config.proxy_user = foo # optional config.proxy_pass = bar # optional end ``` - + Logging ------------ HydraulicBrake uses STDOUT by default. If you want to use a different logger, just pass another `Logger` instance inside your configuration: ```ruby HydraulicBrake.configure do |config| config.logger = Logger.new("path/to/your/log/file") end -``` - -Deploy Hook ------------ - -HydraulicBrake can notify Airbrake whenever you deploy your app. Just -call HydraulicBrake::Hook#deploy whenever you deploy: - -```ruby -HydraulicBrake::Hook.deploy({ - :scm_revision => "cd6b969f66ad0794c7117d5030f926b49f82b038", - :scm_repository => "stevecrozz/hydraulic_brake", - :local_username => "stevecrozz", - :rails_env => "production", # everything is rails, right? - :message => "Another deployment hook brought to you by HydraulicBrake" -}) ``` Credits -------