diff --git a/README.md b/README.md index 3c2db41..f7057e3 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This is a library that can: - Generate a changelog, or releasenotes, from a GIT repository. - Determine next version, based on format of commits since last release. -It is fully configurable with a [Mustache (Handlebars)](https://github.com/jknack/handlebars.java) template and [helpers](#Helpers). +It is fully configurable with a [Mustache (Handlebars)](https://github.com/jknack/handlebars.java) template filled with a [context of placeholders](#Context) and [helpers](#Helpers). The changelog can: @@ -446,15 +446,16 @@ Works just like [Java substring](Click here to show context

``` -- ownerName (Derived from the clone URL, for this repo it would be "tomasbjerre") -- repoName (Derived from the clone URL, for this repo it would be "git-changelog-lib") -- urlParts (Derived from the clone URL, for this repo it would be [git-changelog-lib, tomasbjerre, git@github.com]) +(ownerName, repoName, urlParts - derived from the clone URL, git remote origin MUST BE SET) +- ownerName (for this repo it would be "tomasbjerre") +- repoName (for this repo it would be "git-changelog-lib") +- urlParts (for this repo it would be [git-changelog-lib, tomasbjerre, git@github.com]) * commits - authorName - authorEmailAddress