README.md in instrumental_agent-0.5.1 vs README.md in instrumental_agent-0.6.0
- old
+ new
@@ -8,35 +8,40 @@
```sh
gem 'instrumental_agent'
```
-Visit instrumentalapp.com[instrumentalapp.com] and create an account, then
-initialize the agent with your API key, found in the Docs section.
+Visit instrumentalapp.com[instrumentalapp.com] and create an account,
+then initialize the agent with your API key, found in the Docs section.
+You'll probably want something like this, only enabling the agent in
+production mode so you don't pollute your data.
```sh
I = Instrumental::Agent.new('YOUR_API_KEY', :test_mode => !Rails.env.production?)
```
-We recommend setting test_mode to true in dev/test modes so that you don't pollute your production data.
+You may want to setup two projects, so that you can verify stats in one,
+and release them to production in another.
Now you can begin to use Instrumental to track your application.
```sh
I.gauge('load', 1.23)
I.increment('signups')
```
-Data without historical context sucks. Instrumental lets you
-backfill data, allowing you to see deep into your project's past.
+Streaming data is better with a little historical context. Instrumental
+lets you backfill data, allowing you to see deep into your project's
+past.
```sh
+I.synchronous = true # disables command buffering
User.find_each do |user|
I.increment('signups', 1, user.created_at)
end
```
-Want some general server stats (load, memory, etc.)? Install instrumental_tools and run this command (sorry not daemonized yet :)
+Want some general server stats (load, memory, etc.)? Check out the instrumental_tools gem.
```sh
gem install instrumental_tools
instrument_server
```