README.md in vcr-2.0.0.rc2 vs README.md in vcr-2.0.0
- old
+ new
@@ -67,33 +67,44 @@
Capybara, Mechanize, Rest-Client and HTTParty.
* Includes Rack and Faraday middleware.
## Usage
-Browse the [documentation](http://relishapp.com/myronmarston/vcr) for usage info.
+The docs come in two flavors:
-The [VCR talk given at Philly.rb](http://philly-rb-vcr-talk.heroku.com/) also
-contains good usage info.
+* The [relish docs](http://relishapp.com/myronmarston/vcr) contain
+ example-based documentation (VCR's cucumber suite, in fact). It's a
+ good place to look when you are first getting started with VCR, or if
+ you want to see an example of how to use a feature.
+* The [rubydoc.info docs](http://rubydoc.info/gems/vcr/frames) contain
+ API documentation. The API docs contain detailed info about all of VCR's
+ public API.
+See the [Upgrade](https://github.com/myronmarston/vcr/blob/master/Upgrade.md) doc
+for info about what's new and changed in VCR 2.0.
+
## Release Policy
VCR follows the principles of [semantic versioning](http://semver.org/).
-The [cucumber features](http://relishapp.com/myronmarston/vcr) define
+The [API documentation](http://rubydoc.info/gems/vcr/frames) define
VCR's public API. Patch level releases contain only bug fixes. Minor
releases contain backward-compatible new features. Major new releases
contain backwards-incompatible changes to the public API.
## Ruby Interpreter Compatibility
VCR has been tested on the following ruby interpreters:
* MRI 1.8.7
* MRI 1.9.2
+* MRI 1.9.3
* REE 1.8.7
* JRuby
* Rubinius
+Note that as of VCR 2, 1.8.6 and 1.9.1 are not supported.
+
## Development
* Source hosted on [GitHub](http://github.com/myronmarston/vcr).
* Direct questions and discussions to the [mailing list](http://groups.google.com/group/vcr-ruby).
* Report issues on [GitHub Issues](http://github.com/myronmarston/vcr/issues).
@@ -156,6 +167,7 @@
* [Stale Fish](https://github.com/jsmestad/stale_fish) (Ruby)
* [WebFixtures](http://github.com/trydionel/web_fixtures) (Ruby)
## Copyright
-Copyright (c) 2010-2012 Myron Marston. See LICENSE for details.
+Copyright (c) 2010-2012 Myron Marston. Released under the terms of the
+MIT license. See LICENSE for details.