README.md in sentry-raven-0.4.6 vs README.md in sentry-raven-0.4.7
- old
+ new
@@ -14,12 +14,16 @@
gem "sentry-raven" #, :github => "getsentry/raven-ruby"
```
## Usage
-You'll want to set your ```SENTRY_DSN``` environment variable to the URL on your project's API Keys setting page (e.g. ```https://secret:public@app.getsentry.com/9999```). For more information, see [Configuration](#configuration).
+The easiest way to configure Raven is by setting the ``SENTRY_DSN`` environment variable.
+You'll find this value on your project settings page, and it should resemble something like ```https://secret:public@app.getsentry.com/9999```.
+
+For alternative configuration methods, and other options see [Configuration](#configuration).
+
### Rails 3
In Rails 3, Sentry will "just work," capturing any exceptions thrown in your app. All Rails integrations also
have mixed-in methods for capturing exceptions you've rescued yourself inside of controllers:
@@ -91,17 +95,10 @@
* `level`: a string representing the level of this event (fatal, error, warning, info, debug)
* `server_name`: the hostname of the server
* `tags`: a mapping of [tags](https://www.getsentry.com/docs/tags/) describing this event
* `extra`: a mapping of arbitrary context
-## Testing
-
-```bash
-$ bundle install
-$ rake spec
-```
-
## Configuration
### SENTRY_DSN
After you complete setting up a project, you'll be given a value which we call a DSN, or Data Source Name. It looks a lot like a standard URL, but it's actually just a representation of the configuration required by Raven (the Sentry client). It consists of a few pieces, including the protocol, public and secret keys, the server address, and the project identifier.
@@ -158,15 +155,47 @@
Raven.configure do |config|
config.processors = [Raven::Processor::SanitizeData]
end
```
-## Command Line Interface
+## Testing Your Configuration
-Raven includes a basic CLI for testing your DSN:
+To ensure you've setup your configuration correctly we recommend running the
+included rake task::
-```ruby
-ruby -Ilib ./bin/raven test <DSN>
+```bash
+$ rake raven:test[https://public:secret@app.getsentry.com/3825]
+Client configuration:
+-> server: https://app.getsentry.com
+-> project_id: 3825
+-> public_key: public
+-> secret_key: secret
+
+Sending a test event:
+-> event ID: 033c343c852b45c2a3add98e425ea4b4
+
+Done!
+```
+
+A couple of things to note:
+
+* This won't test your environment configuration. The test CLI forces the your
+ coniguration to represent itself as if it were running in the production env.
+* If you're running within Rails (or anywhere else that will bootstrap the
+ rake environment), you should be able to omit the DSN argument.
+
+## Contributing
+
+### Bootstrap
+
+```bash
+$ bundle install
+```
+
+### Running the test suite
+
+```bash
+$ rake spec
```
Resources
---------