README.md in capistrano-git-submodule-strategy-0.1.17 vs README.md in capistrano-git-submodule-strategy-0.1.18
- old
+ new
@@ -2,25 +2,29 @@
Git submodule support for Capistrano 3 [](http://badge.fury.io/rb/capistrano-git-submodule-strategy)
## Using
-Capfile
+####Capfile
```ruby
require 'capistrano/git-submodule-strategy'
```
-Gemfile
+####Gemfile
```ruby
gem 'capistrano-git-submodule-strategy', '~> 0.1', :github => 'ekho/capistrano-git-submodule-strategy'
```
-deploy.rb
+####deploy.rb
```ruby
set :scm, :git
set :git_strategy, Capistrano::Git::SubmoduleStrategy
```
+Optionally you can keep git metadata (.git directory)
+```ruby
+set :git_keep_meta, true
+```
## Contributing to capistrano-git-submodule-strategy
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
@@ -30,6 +34,6 @@
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
== Copyright
-Copyright (c) 2014 Boris Gorbylev. See LICENSE for further details.
\ No newline at end of file
+Copyright (c) 2014 Boris Gorbylev. See LICENSE for further details.