diff options
| author | Andre Arko <andre@arko.net> | 2012-12-11 16:48:59 -0800 |
|---|---|---|
| committer | Andre Arko <andre@arko.net> | 2012-12-17 12:50:25 -0800 |
| commit | e219de0451f0af19875a2558327d663d5fd9a208 (patch) | |
| tree | e9186fd5e087c50b619da9a505ee8b5c001e05c4 /README.md | |
| parent | 152b8ae706489f1fbf402b79a4b60d73a68303ed (diff) | |
| download | bundler-e219de0451f0af19875a2558327d663d5fd9a208.tar.gz | |
Add contributing section to readme, reword
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 9 insertions, 3 deletions
@@ -1,10 +1,10 @@ # Bundler: a gem to bundle gems [](http://travis-ci.org/carlhuda/bundler) -Bundler manages the gems that a ruby application depends on. Given a list of gems, it can automatically download and install those gems, as well as any other gems needed by the gems that are listed. Before installing gems, it checks the versions of every gem to make sure that they are compatible, and can all be loaded at the same time. After the gems have been installed, Bundler can help you update some or all of them when new versions become available. Finally, it records the exact versions that have been installed, so that others can install the exact same gems. +Bundler keeps ruby applications running the same code on every machine. -### Installation and usage +It does this by managing the gems that the application depends on. Given a list of gems, it can automatically download and install those gems, as well as any other gems needed by the gems that are listed. Before installing gems, it checks the versions of every gem to make sure that they are compatible, and can all be loaded at the same time. After the gems have been installed, Bundler can help you update some or all of them when new versions become available. Finally, it records the exact versions that have been installed, so that others can install the exact same gems. -See [gembundler.com](http://gembundler.com) for installation and usage instructions. tl;dr: +### Installation and usage ``` gem install bundler @@ -14,10 +14,16 @@ bundle install bundle exec rails new myapp ``` +See [gembundler.com](http://gembundler.com) for the full documentation. + ### Troubleshooting For help with common problems, see [ISSUES](https://github.com/carlhuda/bundler/blob/master/ISSUES.md). +### Contributing + +If you'd like to contribute to Bundler, that's awesome, and we <3 you. There's a guide to contributing to Bundler (both code and general help) over in [CONTRIBUTE](https://github.com/carlhuda/bundler/blob/master/CONTRIBUTE.md) + ### Development To see what has changed in recent versions of Bundler, see the [CHANGELOG](https://github.com/carlhuda/bundler/blob/master/CHANGELOG.md). |