Merge pull request #11 from hunner/fix_readme

Clarify instructions for new usage

CHANGEFILE

@@ -1,3 +1,9 @@
+2013-12-05 2.0.1
+- Update readme for breaking changes and deprecation notice. If you previously
+  had `include Serverspec::Helper::RSpecSystem` or `include
+  Serverspec::Helper::DetectOS` in `spec/spec_helper_system.rb` then these
+  should be removed.
+
 2013-12-03 2.0.0
 - Update for new specinfra gem
 

README.md

@@ -5,12 +5,9 @@
 ## Quick Start
 
 * Have a module that is configured to use rspec-system
-* `gem install serverspec`
-* Add the `serverspec` and `rspec-system-serverspec` gems to your module's `Gemfile`
-* Add these lines to your `spec/spec_helper_system.rb` file:
+* Add the `rspec-system-serverspec` gem to your module's `Gemfile`
+* Add the following line to your `spec/spec_helper_system.rb` file:
 
 ```ruby
 require 'rspec-system-serverspec/helpers'
-include Serverspec::Helper::RSpecSystem
-include Serverspec::Helper::DetectOS
 ```

lib/rspec-system-serverspec/helpers.rb

@@ -6,3 +6,10 @@
 
 include SpecInfra::Helper::RSpecSystem
 include SpecInfra::Helper::DetectOS
+
+module Serverspec::Helper::RSpecSystem
+  def self.included(base)
+    # Deprecated in 2.0.0
+    warn "[DEPRECATED] Serverspec::Helper::RSpecSystem is deprecated and should no longer be included. See the README for information."
+  end
+end

rspec-system-serverspec.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   # Metadata
   s.name          = 'rspec-system-serverspec'
-  s.version       = '2.0.0'
+  s.version       = '2.0.1'
   s.authors       = ['Hunter Haugen']
   s.email         = ['[email protected]']
   s.summary       = 'Serverspec rspec-system plugin'