README.md in busted-0.2.0 vs README.md in busted-0.2.1
- old
+ new
@@ -1,19 +1,18 @@
# Busted [](https://travis-ci.org/simeonwillbanks/busted) [](https://codeclimate.com/github/simeonwillbanks/busted)
-#### Disclaimers
-- Requires MRI Ruby 2.1.0dev at [trunk](https://github.com/ruby/ruby/tree/trunk)
+### Find code that busts the Ruby 2.1+ cache.
---
+**Busted** reports when code invalidates Ruby's internal cache.
-Find code that busts the Ruby 2.1+ cache.
+- [Basic Usage](#basic-usage) reports cache invalidations
+- [Advanced Usage](#advanced-usage) details exact invalidation locations via [`dtrace`](http://en.wikipedia.org/wiki/DTrace)
+- [Coming Soon](https://github.com/simeonwillbanks/busted/issues/2) a Rails profiler for reporting cache invalidations per request
+- **Busted** relies upon [RubyVM.stat](http://ruby-doc.org/core-2.1.0/RubyVM.html#method-c-stat) and the [ruby:::method-cache-clear](http://ruby-doc.org/core-2.1.0/doc/dtrace_probes_rdoc.html) `dtrace` probe
-- Report when code invalidates Ruby's internal cache
-- Uses [RubyVM.stat](https://github.com/ruby/ruby/commit/cc1063092b366a0a8449528ab6bf67a72f5ce027)
+## Basic Usage
-## Usage
-
*Any Cache*
```ruby
Busted.cache? do
class Beer
@@ -104,11 +103,11 @@
Busted.finish
#=> {:invalidations=>{:method=>0, :constant=>0}}
```
## Advanced Usage
-Busted can report method cache invalidation locations via [`dtrace`](http://en.wikipedia.org/wiki/DTrace). The running process must have root privileges, and `dtrace` must be installed.
+**Busted** can report method cache invalidation locations via [`dtrace`](http://en.wikipedia.org/wiki/DTrace). The running process must have root privileges, and `dtrace` must be installed.
*trace.rb*
```ruby
require "busted"
require "pp"
@@ -159,14 +158,14 @@
:traces=>
{:method=>
[{:class=>"global", :sourcefile=>"start_finish_trace.rb", :lineno=>"5"}]}}
```
-Busted includes an [example `dtrace` probe](/dtrace/probes/examples/method-cache-clear.d) for use on the command line or an application. See the [probe](/dtrace/probes/examples/method-cache-clear.d) for usage.
+**Busted** includes an [example `dtrace` probe](/dtrace/probes/examples/method-cache-clear.d) for use on the command line or an application. See the [probe](/dtrace/probes/examples/method-cache-clear.d) for usage.
## Installation
-***Requires MRI Ruby 2.1.0dev***
+***Requires MRI Ruby 2.1+***
Add this line to your application's Gemfile:
gem "busted"