diff options
author | The Bundler Bot <bot@bundler.io> | 2017-09-29 11:28:45 +0000 |
---|---|---|
committer | The Bundler Bot <bot@bundler.io> | 2017-09-29 11:28:45 +0000 |
commit | 840a990db0e266e3149a63a305a7849deba095c3 (patch) | |
tree | 0c0a7216f670be325b3909d18252dd8f0e5e6739 | |
parent | 5e9c40aa1c0b4993953059fffe1ff724f41da95e (diff) | |
parent | cf9d5f6bbd39155054d72b7d992cd35e89ff486d (diff) | |
download | bundler-840a990db0e266e3149a63a305a7849deba095c3.tar.gz |
Auto merge of #6068 - koic:update_newgem_readme_template_for_bundler2, r=colby-swandale
Update newgem README.md template for Bundler 2
### What was the end-user problem that led to this PR?
`bundle` command has been changed to display list of commands with Bundle 2.
```console
% bundle
Bundler version 2.0.0.dev (2017-09-29 commit 5e9c40aa1)
Bundler commands:
Primary commands:
bundle install [OPTIONS] # Install the current environment to the system
bundle update [OPTIONS] # Update the current environment
bundle cache [OPTIONS] # Locks and then caches all of the gems into vendor/cache
bundle exec [OPTIONS] # Run the command in context of the bundle
bundle config NAME [VALUE] # Retrieve or set a configuration value
bundle help [COMMAND] # Describe available commands or one specific command
(snip)
```
Therefore, it can not be installed with `bundle` command written in README.md created by `bundle gem`.
### What was your diagnosis of the problem?
It is the same as above.
### What is your fix for the problem, implemented in this PR?
I think that it is better to write `bundle install` in the README template of `bundle gem`.
-rw-r--r-- | lib/bundler/templates/newgem/README.md.tt | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/lib/bundler/templates/newgem/README.md.tt b/lib/bundler/templates/newgem/README.md.tt index 868a0afe67..22ddeaa91a 100644 --- a/lib/bundler/templates/newgem/README.md.tt +++ b/lib/bundler/templates/newgem/README.md.tt @@ -14,7 +14,7 @@ gem '<%= config[:name] %>' And then execute: - $ bundle + $ bundle install Or install it yourself as: |