diff --git a/README.md b/README.md index 4659b40..3d38659 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,27 @@ Beaker library to use vmpooler hypervisor # How to use this wizardry - -This is a gem that allows you to use hosts with [vmpooler](vmpooler.md) hypervisor with [beaker](https://github.com/puppetlabs/beaker). This gem is already included as [beaker dependency](https://github.com/puppetlabs/beaker/blob/master/beaker.gemspec#L59) for you, so you don't need to do anything special to use this gem's functionality with beaker. + +This is a gem that allows you to use hosts with [vmpooler](vmpooler.md) hypervisor with [beaker](https://github.com/puppetlabs/beaker). + +Beaker will automatically load the appropriate hypervisors for any given hosts file, so as long as your project dependencies are satisfied there's nothing else to do. No need to `require` this library in your tests. + +## With Beaker 3.x + +This library is included as a dependency of Beaker 3.x versions, so there's nothing to do. + +## With Beaker 4.x + +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-vmpooler' +# project.gemspec +s.add_runtime_dependency 'beaker', '~>4.0' +s.add_runtime_dependency 'beaker-vmpooler' +~~~ # Spec tests