README.md in vagrant-cachier-0.2.0 vs README.md in vagrant-cachier-0.3.0
- old
+ new
@@ -34,28 +34,26 @@
## Compatible providers
* Vagrant's built in VirtualBox provider
* [vagrant-lxc](https://github.com/fgrehm/vagrant-lxc)
+* [VMware providers](http://www.vagrantup.com/vmware) with NFS enabled (See
+ [GH-24](https://github.com/fgrehm/vagrant-cachier/issues/24) for more info)
-_It is possibly compatible with the [VMware providers](http://www.vagrantup.com/vmware)
-as well but I haven't tried yet._
-
-
## How does it work?
Right now the plugin does not make any assumptions for you and you have to
configure things properly from your `Vagrantfile`. Please have a look at
the [available cache buckets](#available-cache-buckets) section below for more
information.
-Under the hood, the plugin will hook into calls to `Vagrant::Builtin::Provision`
-during `vagrant up` / `vagrant reload` and will set things up for each configured
-cache bucket. Before halting the machine, it will revert the changes required
-to set things up by hooking into calls to `Vagrant::Builtin::GracefulHalt` so
-that you can repackage the machine for others to use without requiring users to
-install the plugin as well.
+Under the hood, the plugin will monkey patch `Vagrant::Builtin::Provision` and
+will set things up for each configured cache bucket before running each defined
+provisioner and after all provisioners are done. Before halting the machine,
+it will revert the changes required to set things up by hooking into calls to
+`Vagrant::Builtin::GracefulHalt` so that you can repackage the machine for others
+to use without requiring users to install the plugin as well.
Cache buckets will be available from `/tmp/vagrant-cachier` on your guest and
the appropriate folders will get symlinked to the right path _after_ the machine is
up but _right before_ it gets provisioned. We _could_ potentially do it on one go
and share bucket's folders directly to the right path if we were only using VirtualBox
@@ -166,10 +164,22 @@
end
```
Used by Arch Linux, will get configured under guest's `/var/cache/pacman/pkg`.
+#### Chef
+
+```ruby
+Vagrant.configure("2") do |config|
+ config.vm.box = 'some-box-using-chef-provisioner'
+ config.cache.enable :chef
+end
+```
+
+When a Chef provisioner is detected, this bucket caches the default
+`file_cache_path` directory, `/var/chef/cache`. Requires Vagrant 1.2.4+.
+
#### RubyGems
```ruby
Vagrant.configure("2") do |config|
config.vm.box = 'some-box-with-ruby-installed'
@@ -180,10 +190,9 @@
Compatible with probably with any type of guest distro, will hook into the `cache`
folder under the result of running `gem env gemdir` as the default SSH user (usualy
`vagrant`) on your guest. If you use rbenv / rvm on the guest machine, make sure
it is already installed before enabling the bucket, otherwise you won't benefit
from this plugin.
-
#### RVM
```ruby
Vagrant.configure("2") do |config|