README.md in git-pivotal-tracker-integration-1.1.0 vs README.md in git-pivotal-tracker-integration-1.2.0
- old
+ new
@@ -1,14 +1,16 @@
# Git Pivotal Tracker Integration
+[](http://badge.fury.io/rb/git-pivotal-tracker-integration)
+[](https://travis-ci.org/nebhale/git-pivotal-tracker-integration)
`git-pivotal-tracker-integration` provides a set of additional Git commands to help developers when working with [Pivotal Tracker][pivotal-tracker].
[pivotal-tracker]: http://www.pivotaltracker.com
## Installation
-`git-pivotal-tracker-integration` requires at least **Ruby 2.0.0** and **Git 1.8.2.1** in order to run. In order to install it, do the following:
+`git-pivotal-tracker-integration` requires at least **Ruby 1.8.7** and **Git 1.8.2.1** in order to run. It is tested against Rubies _1.8.7_, _1.9.3_, and _2.0.0_. In order to install it, do the following:
```plain
$ gem install git-pivotal-tracker-integration
```
@@ -131,5 +133,36 @@
[Completes #12345678]
```
After merging, the development branch is deleted and the changes are pushed to the remote repository.
+
+### `git release [issue]`
+This command creates a release for a story. It does this by updating the version string in the project and creating a tag. This command can be run in two ways. First it can be run specifying the release that you want to create.
+
+```plain
+$ git release 12345678
+```
+The other way the command can be run without specifying anything. In this case, it will select the first release story (based on the backlog's order).
+
+```plain
+$ git release
+ Title: Lorem ipsum dolor sit amet, consectetur adipiscing elitattributes
+```
+
+Once a story has been selected by one of the two methods, the command then prompts for the release version and next development version.
+
+```plain
+$ git release
+ Title: Lorem ipsum dolor sit amet, consectetur adipiscing elitattributes
+
+Enter release version (current: 1.0.0.BUILD-SNAPSHOT): 1.0.0.M1
+Enter next development version (current: 1.0.0.BUILD-SNAPSHOT): 1.1.0.BUILD-SNAPSHOT
+Creating tag v1.0.0.M1... OK
+Pushing to origin... OK
+```
+
+Once these have been entered, the version string for the current project is updated to the release version and a tag is created. Then the version string for the current project is updated to the next development version and a new commit along the original branch is created. Finally the tag and changes are pushed to the remote sever.
+
+Version update is currently supported for the following kinds of projects. If you do not see a project type that you would like supported, please open an issue or submit a pull request.
+
+* Gradle