diff options
author | Andrey Ognevsky <a.ognevsky@gmail.com> | 2011-12-03 13:02:38 +0200 |
---|---|---|
committer | Andrey Ognevsky <a.ognevsky@gmail.com> | 2011-12-04 01:32:23 +0200 |
commit | 233c3187fe4ac73b92a1460ef1b07ef142c9d169 (patch) | |
tree | 5c7d60ca50a6dfca0b59f1bc9ef167c704106b37 | |
parent | 26fa77aea2c8dc7d738b7df355206966043c9b96 (diff) | |
download | bundler-233c3187fe4ac73b92a1460ef1b07ef142c9d169.tar.gz |
Added README.md to newgem
* Added README.md to newgem
* Removed 'Wait' list item
* Added Installation instructions
-rw-r--r-- | lib/bundler/cli.rb | 1 | ||||
-rw-r--r-- | lib/bundler/templates/newgem/README.md.tt | 29 |
2 files changed, 30 insertions, 0 deletions
diff --git a/lib/bundler/cli.rb b/lib/bundler/cli.rb index c7ddfe8bd1..ed02eed083 100644 --- a/lib/bundler/cli.rb +++ b/lib/bundler/cli.rb @@ -560,6 +560,7 @@ module Bundler template(File.join("newgem/Gemfile.tt"), File.join(target, "Gemfile"), opts) template(File.join("newgem/Rakefile.tt"), File.join(target, "Rakefile"), opts) template(File.join("newgem/LICENSE.tt"), File.join(target, "LICENSE"), opts) + template(File.join("newgem/README.md.tt"), File.join(target, "README.md"), opts) template(File.join("newgem/gitignore.tt"), File.join(target, ".gitignore"), opts) template(File.join("newgem/newgem.gemspec.tt"), File.join(target, "#{name}.gemspec"), opts) template(File.join("newgem/lib/newgem.rb.tt"), File.join(target, "lib/#{name}.rb"), opts) diff --git a/lib/bundler/templates/newgem/README.md.tt b/lib/bundler/templates/newgem/README.md.tt new file mode 100644 index 0000000000..23a4b10beb --- /dev/null +++ b/lib/bundler/templates/newgem/README.md.tt @@ -0,0 +1,29 @@ +# <%=config[:constant_name]%> + +TODO: Write a gem description + +## Installation + +Add this line to your application's Gemfile: + + gem '<%=config[:name]%>' + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install <%=config[:name]%> + +## Usage + +TODO: Write usage instructions here + +## Contributing + +1. Fork it +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Added some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create new Pull Request |