README.md in beaker-puppet-0.17.1 vs README.md in beaker-puppet-1.0.0

- old
+ new

@@ -7,9 +7,30 @@ you see anything puppet-specific that you'd like to pull into this library out of beaker, please do, we would love any help that you'd like to provide. # How Do I Use This? +## With Beaker 3.x + +This library is included as a dependency of Beaker 3.x versions and is automatically included, so there's nothing to do. + +## With Beaker 4.x + +As of Version 1.0 of `beaker-puppet`, the minimum supported version of beaker is Version 4.0. If you use `ENV['BEAKER_VERSION']`, you will have to ensure that this is compatible, and that if you are using a local Git repository it is up to date. + +As of beaker 4.0, all hypervisor and DSL extension libraries have been removed and are no longer dependencies. In order to use a specific hypervisor or DSL extension library in your project, you will need to include them alongside Beaker in your Gemfile or project.gemspec. E.g. + +~~~ruby +# Gemfile +gem 'beaker', '~>4.0' +gem 'beaker-puppet', '~>1.0' +# project.gemspec +s.add_runtime_dependency 'beaker', '~>4.0' +s.add_runtime_dependency 'beaker-puppet', '~>1.0' +~~~ + +For DSL Extension Libraries, you must also ensure that you `require` the library in your test files. You can do this manually in individual test files or in a test helper (if you have one). You can [use `Bundler.require()`](https://bundler.io/v1.16/guides/groups.html) to require the library automatically. + ### Right Now? (beaker 3.x) At this point, beaker-puppet is included in beaker, so you don't have to _do_ anything to get the methods in this library.