README.md in instana-0.1.0 vs README.md in instana-0.8.beta1
- old
+ new
@@ -1,14 +1,12 @@
# Instana
-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/instana`. To experiment with that code, run `bin/console` for an interactive prompt.
+The Instana gem provides Ruby metrics for [Instana](https://www.instana.com/).
-TODO: Delete this and the text above, and describe your gem
-
## Installation
-Add this line to your application's Gemfile:
+The gem is available on [Rubygems](https://rubygems.org/gems/instana). To install, add this line to _the end_ of your application's Gemfile:
```ruby
gem 'instana'
```
@@ -20,17 +18,28 @@
$ gem install instana
## Usage
-TODO: Write usage instructions here
+The instana gem is a zero configuration tool that will automatically collect key metrics from your Ruby processes. Just install and go.
+## Configuration
+
+Although the gem has no configuration required for metrics, individual components can be disabled with a local config.
+
+To disable a single component in the gem, you can disable a single component with the following code:
+
+```Ruby
+::Instana.config[:metrics][:gc][:enabled] = false
+```
+Current components are `:gc`, `:memory` and `:thread`.
+
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/instana.
+Bug reports and pull requests are welcome on GitHub at https://github.com/instana/ruby-sensor.