README.md in sentry-raven-0.1 vs README.md in sentry-raven-0.2
- old
+ new
@@ -9,13 +9,18 @@
## Installation
Add the following to your `Gemfile`:
```ruby
-gem "raven", :git => "https://github.com/coderanger/raven-ruby.git"
+gem "sentry-raven", :git => "https://github.com/coderanger/raven-ruby.git"
```
+Or install manually
+```bash
+$ gem install sentry-raven
+```
+
## Usage
### Rails 3
Add a `config/initializers/raven.rb` containing:
@@ -51,20 +56,38 @@
```ruby
require 'raven'
Raven.configure do |config|
config.dsn = 'http://public:secret@example.com/project-id'
+
+ # manually configure environment if ENV['RACK_ENV'] is not defined
+ config.current_environment = 'production'
end
Raven.capture # Global style
Raven.capture do # Block style
- ...
+ 1 / 0
end
```
## Testing
```bash
$ bundle install
$ rake spec
```
+
+## Notifications in development mode
+
+By default events will only be sent to Sentry if your application is running in a production environment. This is configured by default if you are running a Rack application (i.e. anytime `ENV['RACK_ENV']` is set).
+
+You can configure Raven to run in non-production environments by configuring the `environments` whitelist:
+
+```ruby
+require 'raven'
+
+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