From ce527408a48305a2180b8f597e1cdd2646381f72 Mon Sep 17 00:00:00 2001 From: Madhav Khurana Date: Wed, 2 Oct 2019 19:53:05 +0530 Subject: [PATCH] grammar updates --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 24fc372..701ffe2 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,9 @@ GitReleaseNotes [![Chocolatey](https://img.shields.io/chocolatey/v/gitreleasenotes.svg)](https://chocolatey.org/packages/GitReleaseNotes.Portable) [![Build status](https://ci.appveyor.com/api/projects/status/br0rijb3rgn1qb0c/branch/master?svg=true)](https://ci.appveyor.com/project/GitTools/gitreleasenotes/branch/master) -Utility which makes it really easy to generate release notes for your Git project. Works with GitHub, Jira and YouTrack. TFS Support coming soon +Utility which makes it really easy to generate release notes for your Git project. Works with GitHub, Jira and YouTrack. TFS Support coming soon. -Have a look at the release notes in this Repo for a sample of what is generated by GitReleaseNotes +Have a look at the release notes in this Repo for a sample of what is generated by GitReleaseNotes. ## Install @@ -31,9 +31,9 @@ This will write `ReleaseNotes.md` into the root of your repo, the release notes - Use the git remote to connect to your issue tracker (if possible, i.e issue tracker is GitHub) - Otherwise specify the issue tracker on the command line (`/IssueTracker Jira /JiraServer MyJiraServer` as well as project name, check `/?` for more info) - - Find closed issues since the last release and generate your release notes - - Use /allTags to generate complete release notes for all releases - - If the release notes are already generated, GitReleaseNotes will *append* **new** closed issues to your release notes, meaning all custom edits will be retained + - Find closed issues since the last release and generate your release notes. + - Use /allTags to generate complete release notes for all releases. + - If the release notes are already generated, GitReleaseNotes will *append* **new** closed issues to your release notes, meaning all custom edits will be retained. - Writes out the release notes following [SemanticReleaseNotes.org](http://www.semanticreleasenotes.org/) You can also use GitReleaseNotes to create a GitHub release, and generate the release notes automatically allowing fully automated releases including release notes generation. @@ -41,7 +41,7 @@ You can also use GitReleaseNotes to create a GitHub release, and generate the re If you use GitHub milestones to manage your releases [GitHubReleaseNotes](https://github.com/Particular/GitHubReleaseNotes) is a similar project. ## Versioning a release -[GitVersion](https://github.com/GitTools/GitVersion) is another project which can help you generate version numbers and make following Semantic Versions easily +[GitVersion](https://github.com/GitTools/GitVersion) is another project which can help you generate version numbers and make following Semantic Versions easily. ## Publishing a release Initial versions of this tool allowed publishing to GitHub. This has been removed.