README.md in tracebin-0.0.12 vs README.md in tracebin-0.0.13
- old
+ new
@@ -36,9 +36,38 @@
config.enabled = false # You can completely disable the agent under the conditions of your choosing.
end
end
```
+## Compatibility
+
+`tracebin-ruby` has instrumentation in place for the following components:
+
+### Rails
+
+`tracebin-ruby` is compatible with Rails 4+.
+
+- ActionController
+- ActiveRecord
+- ActionView
+
+### Background Jobs
+
+- ActiveJob
+- Sidekiq
+- Resque
+
+### Sinatra
+
+- Routes (used in place of ActionController)
+
+### Databases
+
+If ActiveRecord isn't used, then we've implemented patches for the following database adapters:
+
+- PG (PostgreSQL)
+- Mysql2 (MySQL)
+
## 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).