README.md in rollbar_helper-0.0.4 vs README.md in rollbar_helper-0.1.0

- old
+ new

@@ -1,10 +1,10 @@ # RollbarHelper -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rollbar_helper`. To experiment with that code, run `bin/console` for an interactive prompt. +When you call `Rollbar.error('description')`, rollbar doesn't provide a stacktrace, just the "description" error. To find exactly where this error was generated, one has to search the entire codebase for `"description"`. -TODO: Delete this and the text above, and describe your gem +This gem allows you to call `RollbarHelper.error('description')` and get a stacktrace on https://rollbar.com pointing where in the code it was exactly generated. ## Installation Add this line to your application's Gemfile: @@ -20,20 +20,27 @@ $ gem install rollbar_helper ## Usage -TODO: Write usage instructions here +Keep your `gem 'rollbar'` dependency and your rollbar configuration. +Instead of calling `Rollbar.error(...)`, call +```ruby +RollbarHelper.error(...) +``` + +`...` could be a string or an Exception + ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/santi-h/rollbar_helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcome on GitHub at https://github.com/bodyshopbidsdotcom/rollbar_helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. ## License The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).