README.md in git_repo_upgrader-0.0.5 vs README.md in git_repo_upgrader-0.0.7
- old
+ new
@@ -1,11 +1,18 @@
# git_repo_upgrader
+[![Gem](https://img.shields.io/gem/v/git_repo_upgrader?_color=default&style=plastic&logo=ruby&logoColor=red)](https://rubygems.org/gems/git_repo_upgrader)
+![downloads](https://img.shields.io/gem/dt/git_repo_upgrader?color=blue&style=plastic)
+[![License: MIT](https://img.shields.io/badge/License-MIT-gold.svg?style=plastic&logo=mit)](LICENSE)
-Copy specific files from another git repository into your current project and provide (optional) automatic commits.
+> Copy specific files from another git repository into your current project and provide (optional) automatic commits.
Useful for manually integrated files from another git project. Do upgrades by one command.
+```diff
+- early version, not to be meant for production use
+```
+
# Contents
* [Installation](#installation)
* [Usage](#usage)
* [Documentation](#documentation)
@@ -48,11 +55,11 @@
<a name="usage"></a>
## Usage
At best create a new rake task containing a options hash and then run #upgrade.
-See the examples below for option hahes.
+See the examples below for option hashes.
### Examples
#### Basic
@@ -65,10 +72,11 @@
files_to_copy: {
'dist/app.bundle.js' => 'web/js/lib/project/app.bundle.js',
'dist/app.bundle.css' => 'web/js/lib/project/app.bundle.css',
# copy a whole directory recursively
'dist/img' => 'web/js/lib/project/img',
- }
+ },
+ commit: 'prompt' # 'prompt' by default, other options: 'false','auto'
}
GitRepoUpgrader.upgrade options
```