README.md in sentry-raven-0.2 vs README.md in sentry-raven-0.3
- old
+ new
@@ -1,19 +1,19 @@
# Raven-Ruby
-[](http://travis-ci.org/coderanger/raven-ruby)
+[](http://travis-ci.org/getsentry/raven-ruby)
-A client and integration layer for the [Sentry](https://github.com/dcramer/sentry) error reporting API.
+A client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
This library is still forming, so if you are looking to just use it, please check back in a few weeks.
## Installation
Add the following to your `Gemfile`:
```ruby
-gem "sentry-raven", :git => "https://github.com/coderanger/raven-ruby.git"
+gem "sentry-raven", :git => "https://github.com/getsentry/raven-ruby.git"
```
Or install manually
```bash
$ gem install sentry-raven
@@ -35,11 +35,11 @@
### Rails 2
No support for Rails 2 yet.
-### Other Rack Servers
+### Rack
Basic RackUp file.
```ruby
require 'raven'
@@ -49,10 +49,27 @@
end
use Raven::Rack
```
+### Sinatra
+
+```ruby
+require 'sinatra'
+require 'raven'
+
+Raven.configure do |config|
+ config.dsn = 'http://public:secret@example.com/project-id'
+end
+
+use Raven::Rack
+
+get '/' do
+ 1 / 0
+end
+```
+
### Other Ruby
```ruby
require 'raven'
@@ -88,6 +105,46 @@
Raven.configure do |config|
config.dsn = 'http://public:secret@example.com/project-id'
config.environments = %w[ development production ]
end
-```
\ No newline at end of file
+```
+
+## Excluding Exceptions
+
+If you never wish to be notified of certain exceptions, specify 'excluded_exceptions' in your config file.
+
+In the example below, the exceptions Rails uses to generate 404 responses will be suppressed.
+
+```ruby
+require 'raven'
+
+Raven.configure do |config|
+ config.dsn = 'http://public:secret@example.com/project-id'
+ config.excluded_exceptions = ['ActionController::RoutingError', 'ActiveRecord::RecordNotFound']
+end
+```
+
+## Sanitizing Data (Processors)
+
+If you need to sanitize or pre-process (before its sent to the server) data, you can do so using the Processors
+implementation. By default, a single processor is installed (Raven::Processors::SanitizeData), which will attempt to
+sanitize keys that match various patterns (e.g. password) and values that resemble credit card numbers.
+
+To specify your own (or to remove the defaults), simply pass them with your configuration:
+
+```ruby
+require 'raven'
+
+Raven.configure do |config|
+ config.dsn = 'http://public:secret@example.com/project-id'
+ config.processors = [Raven::Processors::SanitizeData]
+end
+
+Resources
+---------
+
+* `Bug Tracker <http://github.com/getsentry/raven-ruby/issues>`_
+* `Code <http://github.com/getsentry/raven-ruby>`_
+* `Mailing List <https://groups.google.com/group/getsentry>`_
+* `IRC <irc://irc.freenode.net/sentry>`_ (irc.freenode.net, #sentry)
+