Skip to content

Commit e688508

Browse files
committed
Updating readme to reflect the rename to GitVersion
1 parent e00bf89 commit e688508

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
![Icon](https://raw.github.com/Particular/GitFlowVersion/master/Icons/package_icon.png)
1+
![Icon](https://raw.github.com/Particular/GitVersion/master/Icons/package_icon.png)
22

3-
Use convention to derive a SemVer product version from a GitFlow based repository
3+
Use convention to derive a SemVer product version from a GitFlow/GitHubFlow based repository. To detect that branching model that is in use GitVersion will look for a develop branch. If a develop branch is found GitFlow based version will be appiled
44

55
## Usage:
66

7-
GitFlowVersion can be used in several ways
7+
GitVersion can be used in several ways
88

99
### 1. An MSBuild Task
1010

11-
This will wire GitFlowVersion into the MSBuild pipeline of a project and automatically stamp that assembly with the appropriate SemVer information
11+
This will wire GitVersion into the MSBuild pipeline of a project and automatically stamp that assembly with the appropriate SemVer information
1212

1313
Available on [Nuget](https://www.nuget.org) under [GitFlowVersionTask](https://www.nuget.org/packages/GitFlowVersionTask/)
1414

1515
Install-Package GitFlowVersionTask
1616

1717
### 2. A nuget reference package
1818

19-
This can be used if you want to reference GitFlowVersion and reuse is from .net.
19+
This can be used if you want to reference GitVersion and reuse is from .net.
2020

2121
Available on [Nuget](https://www.nuget.org) under [GitFlowVersion](https://www.nuget.org/packages/GitFlowVersion/)
2222

@@ -71,7 +71,7 @@ This also have the added benefit of forcing us to follow our branching strategy
7171

7272
### Assumptions:
7373

74-
* Using the [GitFlow branching model](http://nvie.com/git-model/) which means that we always have a master and a develop branch.
74+
* Using the [GitFlow branching model](http://nvie.com/git-model/) which means that we always have a master and a develop branch or the [GitHubFlow branching model](http://scottchacon.com/2011/08/31/github-flow.html) which only has a master branch.
7575
* Following [Semantic Versioning](http://semver.org/)
7676
* Planned releases (bumps in major or minor) are done on release branches prefixed with release-. Eg: release-4.1 (or release-4.1.0)
7777
* Hotfixes are prefixed with hotfix- Eg. hotfix-4.0.4

0 commit comments

Comments
 (0)