README.md in vendorise-0.1.0 vs README.md in vendorise-0.1.1
- old
+ new
@@ -1,32 +1,34 @@
# Vendorise
-A reusable rake task to vendorise a gem hosted in a private git repo, using git subtree (requires git 1.8)
+[](http://badge.fury.io/rb/vendorise)
+[](https://travis-ci.org/New-Bamboo/vendorise)
-## Installation
+Sometimes you need to use a gem that is only available in a private git repository. There are a few ways to do this:
-Add this line to your application's Gemfile (if you're using Rails, only add it to the development group):
+* Install an SSH certificate on your server, but it's not always an option (for example, if you use [Heroku](http://heroku.com))
+* Use [Gemfury](http://gemfury.com), but that costs money and potentially creates privacy concerns
+* Hard-code an oauth token into your Gemfile (if the gem is hosted on [github](http://github.com)), but then anyone with access to the code also has access to all of your github repositories
- gem 'vendorise'
+Vendorise offers a different way of accessing privately hosted gems, by using git's subtree command to download the gem on your development machine and commit it into the source tree of your repository.
-And then execute:
+By using subtree, updating the code is straightforward and your server does not need to have access to the private git repository. For more explanation about git subtree and why you'd want to use it, I recommend reading [Alternatives To Git Submodule: Git Subtree](http://blogs.atlassian.com/2013/05/alternatives-to-git-submodule-git-subtree/).
- $ bundle
+*Note:* vendorise relies on the git subtree command to work - only recent versions of git have this
-Or install it yourself as:
+## Installation
+If you're using bundler add this line to your application's Gemfile:
+
+ gem 'vendorise', group: :development
+
+Or if you don't use bundler:
+
$ gem install vendorise
## Usage
1. Run `rake vendorise:gem[repo_url]` to vendorise the gem hosted at `repo_url` into `/vendor/gems`.
2. Add `gem '<gem_name>', path: 'vendor/gems/<gem_name>'` to your Gemfile
-You can update the gem at any time by running the rake task again
+You can update the gem at any time by running the rake task again. Vendorise always uses the code from the master branch on git (tags are not supported yet).
-## 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. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request