README.md in vagrant-plugin-bundler-0.1.0 vs README.md in vagrant-plugin-bundler-0.1.1
- old
+ new
@@ -1,13 +1,21 @@
# Vagrant PluginBundler Plugin
+[](https://travis-ci.org/tknerr/vagrant-plugin-bundler)
+
This is a [Vagrant](http://www.vagrantup.com) 1.2+ plugin which hooks in before `vagrant up` and `vagrant reload` and ensures that the required vagrant plugins as specified in your Vagrantfile are installed. Think of a minimalist [Bundler](http://gembundler.com) for vagrant plugins.
-## Usage
+## Installation
-Install using standard Vagrant 1.1+ plugin installation methods. After installing, you can specify the required plugin dependencies in your `Vagrantfile` like so:
+Install using the standard Vagrant 1.1+ plugin installation method:
+```
+$ vagrant plugin install vagrant-plugin-bundler
+```
+## Usage
+
+After installing, you can specify the required plugin dependencies in your `Vagrantfile` like so:
```ruby
Vagrant.configure("2") do |config|
# require the vagrant-omnibus plugin...
config.plugin.depend 'vagrant-omnibus', '1.0.2'
@@ -49,5 +57,34 @@
[foo] Forwarding ports...
[foo] -- 22 => 2201 (adapter 1)
[foo] Booting VM...
...
```
+
+## Block Syntax
+
+If you have multiple dependencies, you can specify them line by line:
+```ruby
+ # multiple plugin dependencies, one per line
+ config.plugin.depend 'vagrant-omnibus', '1.0.2'
+ config.plugin.depend 'vagrant-cachier', '0.1.0'
+ config.plugin.depend 'vagrant-aws', '0.2.2'
+```
+
+But it reads better if you use the block syntax:
+```ruby
+ # multiple plugin dependencies in a block
+ config.plugin.deps do
+ depend 'vagrant-omnibus', '1.0.2'
+ depend 'vagrant-cachier', '0.1.0'
+ depend 'vagrant-aws', '0.2.2'
+ end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Make sure specs are passing (`rake spec`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request