Skip to content

Commit b0f6c77

Browse files
committed
updated README
1 parent 0d83d66 commit b0f6c77

File tree

2 files changed

+28
-3
lines changed

2 files changed

+28
-3
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ You are seeing:
4949
designed by [David Chapman][app-icon-author]
5050
from The Noun Project.
5151

52-
[semver]: http://semver.org
52+
[semver]: https://semver.org
5353
[gitter]: https://gitter.im/GitTools/GitVersion?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
5454
[gitter-badge]: https://badges.gitter.im/Join+Chat.svg
5555
[azure-pipeline]: https://dev.azure.com/GitTools/GitVersion/_build/latest?definitionId=1
@@ -87,4 +87,4 @@ from The Noun Project.
8787
[gv-in-action]: https://raw.githubusercontent.com/GitTools/GitVersion/master/docs/input/docs/img/README.png
8888
[banner]: https://raw.githubusercontent.com/GitTools/graphics/master/GitVersion/banner-1280x640.png
8989
[app-icon]: https://thenounproject.com/term/tree/13389/
90-
[app-icon-author]: http://thenounproject.com/david.chapman
90+
[app-icon-author]: https://thenounproject.com/david.chapman

build/docker/Tasks/DockerHubReadmePublish.cs

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,11 @@ private static string GetReadmeContent(BuildContextBase context)
5757
// language=markdown
5858
var readme = $"""
5959
# GitVersion
60+
![GitVersion – From git log to SemVer in no time][banner]
6061
61-
This repository contains the Docker images for [GitVersion](https://gitversion.net).
62+
Versioning when using Git, solved. GitVersion looks at your git history and works out the [Semantic Version][semver] of the commit being built.
63+
64+
This repository contains the Docker images for [GitVersion][website]. Source code can be found at [src](https://github.com/GitTools/GitVersion)
6265
6366
## Usage
6467
@@ -82,6 +85,28 @@ Note that the path `/repo` needs to be passed as an argument since the `gitversi
8285
docker run --rm -v "$(pwd):/repo" gittools/gitversion:{tag}-amd64 /repo
8386
docker run --rm -v "$(pwd):/repo" gittools/gitversion:{tag}-arm64 /repo
8487
```
88+
89+
## Quick Links
90+
91+
* [Documentation][docs]
92+
* [Contributing][contribute]
93+
* [Why GitVersion][why]
94+
* [Usage][usage]
95+
* [How it works][how]
96+
* [FAQ][faq]
97+
* [Who is using GitVersion][who]
98+
99+
[website]: https://gitversion.net
100+
[docs]: https://gitversion.net/docs/
101+
[contribute]: https://github.com/GitTools/GitVersion/blob/main/CONTRIBUTING.md
102+
[why]: https://gitversion.net/docs/learn/why
103+
[usage]: https://gitversion.net/docs/usage
104+
[how]: https://gitversion.net/docs/learn/how-it-works
105+
[faq]: https://gitversion.net/docs/learn/faq
106+
[who]: https://gitversion.net/docs/learn/who
107+
[src]: https://github.com/GitTools/GitVersion
108+
[semver]: https://semver.org
109+
[banner]: https://raw.githubusercontent.com/GitTools/graphics/master/GitVersion/banner-1280x640.png
85110
""";
86111
return readme;
87112
}

0 commit comments

Comments
 (0)