README.md in toystore-0.13.1 vs README.md in toystore-0.13.2
- old
+ new
@@ -1,6 +1,6 @@
-# Toystore [![Build Status](https://secure.travis-ci.org/jnunemaker/toystore.png)](http://travis-ci.org/jnunemaker/toystore)
+# Toystore
An object mapper for any [adapter](https://github.com/jnunemaker/adapter) that can read, write, delete, and clear data.
## Examples
@@ -203,9 +203,37 @@
```
If that doesn't excite you, nothing will. At this point, you are probably wishing for more.
Luckily, there is an entire directory full of [examples](https://github.com/jnunemaker/toystore/tree/master/examples) and I created a few power user guides, which I will kindly link next.
+
+## Instrumentation
+
+ToyStore comes with a log subscriber and automatic metriks instrumentation. By
+default these work with ActiveSupport::Notifications, but only require the
+pieces of ActiveSupport that are needed and only do so if you actually attempt
+to require the instrumentation files listed below.
+
+To use the log subscriber:
+
+```ruby
+# Gemfile
+gem 'activesupport'
+
+# config/initializers/toystore.rb (or wherever you want it)
+require 'toy/instrumentation/log_subscriber'
+```
+
+To use the metriks instrumentation:
+
+```ruby
+# Gemfile
+gem 'activesupport'
+gem 'metriks'
+
+# config/initializers/toystore.rb (or wherever you want it)
+require 'toy/instrumentation/metriks'
+```
## ToyStore Power User Guides
* [Wiki Home](https://github.com/jnunemaker/toystore/wiki)
* [Identity](https://github.com/jnunemaker/toystore/wiki/Identity)