Skip to content
This repository has been archived by the owner on Dec 26, 2017. It is now read-only.

Commit

Permalink
Format markdown
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Smith <tsmith@chef.io>
  • Loading branch information
tas50 committed Aug 5, 2016
1 parent 7b9a17b commit a92f5ed
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 32 deletions.
31 changes: 19 additions & 12 deletions CONTRIBUTING.md
Expand Up @@ -6,11 +6,8 @@ If you'd like to submit a patch:

1. Fork the project.
2. Make your feature addition or bug fix.
3. Add [tests](#testing) for it. This is important so that it isn't broken in a
future version unintentionally.
4. Commit. **Do not touch any unrelated code, such as the gemspec or version.**
If you must change unrelated code, do it in a commit by itself, so that it
can be ignored.
3. Add [tests](#testing) for it. This is important so that it isn't broken in a future version unintentionally.
4. Commit. **Do not touch any unrelated code, such as the gemspec or version.** If you must change unrelated code, do it in a commit by itself, so that it can be ignored.
5. Send a pull request.

## Testing
Expand All @@ -19,26 +16,36 @@ If you'd like to submit a patch:

Install the latest version of [Bundler](http://gembundler.com)

$ gem install bundler
```sh
$ gem install bundler
```

Clone the project

$ git clone https://github.com/berkshelf/vagrant-berkshelf.git
```sh
$ git clone https://github.com/berkshelf/vagrant-berkshelf.git
```

and run:

$ cd vagrant-berkshelf
$ bundle install
```sh
$ cd vagrant-berkshelf
$ bundle install
```

Bundler will install all gems and their dependencies required for testing and developing.

### Running tests

One-time run with Rake

$ bundle exec rake spec
```sh
$ bundle exec rake spec
```

Or you can setup a quick feedback loop with Guard

$ bundle exec guard start
guard> rspec
```sh
$ bundle exec guard start
guard> rspec
```
34 changes: 14 additions & 20 deletions README.md
@@ -1,29 +1,22 @@
Vagrant Berkshelf Plugin
========================
[![Gem Version](http://img.shields.io/gem/v/vagrant-berkshelf.svg)][gem]
[![Build Status](http://img.shields.io/travis/berkshelf/vagrant-berkshelf.svg)][travis]
# Vagrant Berkshelf Plugin

[gem]: https://rubygems.org/gems/vagrant-berkshelf
[travis]: http://travis-ci.org/berkshelf/vagrant-berkshelf
[![Gem Version](http://img.shields.io/gem/v/vagrant-berkshelf.svg)][gem] [![Build Status](http://img.shields.io/travis/berkshelf/vagrant-berkshelf.svg)][travis]

Vagrant Berkshelf is a Vagrant plugin that adds Berkshelf integration to the
Chef provisioners. Vagrant Berkshelf will automatically download and install
cookbooks onto the Vagrant Virtual Machine.
Vagrant Berkshelf is a Vagrant plugin that adds Berkshelf integration to the Chef provisioners. Vagrant Berkshelf will automatically download and install cookbooks onto the Vagrant Virtual Machine.

## Installation

Installation
------------
1. Install the latest version of [Vagrant](http://www.vagrantup.com/downloads.html)
2. Install the latest version of [ChefDK](https://downloads.chef.io/chef-dk/)
3. Install the Vagrant Berkshelf plugin:

$ vagrant plugin install vagrant-berkshelf
```sh
$ vagrant plugin install vagrant-berkshelf
```

## Usage

Usage
-----
If the Vagrant Berkshelf plugin is installed, it will intelligently detect when a
Berksfile is present in the same working directory as the Vagrantfile.
If the Vagrant Berkshelf plugin is installed, it will intelligently detect when a Berksfile is present in the same working directory as the Vagrantfile.

Here is an example Vagrantfile configuration section for Vagrant Berkshelf:

Expand Down Expand Up @@ -51,19 +44,17 @@ Vagrant.configure("2") do |config|
end
```

## Contributing

Contributing
------------
Thank you to all of our [Contributors](https://github.com/berkshelf/vagrant-berkshelf/graphs/contributors), testers, and users.

- Please report issues [on the GitHub issue tracker](https://github.com/berkshelf/berkshelf/issues)
- Hangout with us in #chef or #berkshelf on freenode

If you'd like to contribute, please see our [contribution guidelines](https://github.com/berkshelf/vagrant-berkshelf/blob/master/CONTRIBUTING.md) first.

## License & Authors

License & Authors
-----------------
- Jamie Winsor (jamie@vialstudios.com)
- Michael Ivey (michael.ivey@riotgames.com)
- Seth Vargo (sethvargo@gmail.com)
Expand All @@ -83,3 +74,6 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

[gem]: https://rubygems.org/gems/vagrant-berkshelf
[travis]: http://travis-ci.org/berkshelf/vagrant-berkshelf

0 comments on commit a92f5ed

Please sign in to comment.