Doc

tomasbjerre · Nov 14, 2015 · 83a8a7b · 83a8a7b
1 parent 5c54861
commit 83a8a7b
Show file tree

Hide file tree

Showing 3 changed files with 115 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,110 @@
 # Git Release Notes [![Build Status](https://travis-ci.org/tomasbjerre/git-changelog.svg?branch=master)](https://travis-ci.org/tomasbjerre/git-changelog)
 
-...
+This is a library for generating a changelog, or releasenotes, from a GIT repository. It can also be run as a standalone program.
+
+It is fully configurable with a [Mustache](http://mustache.github.io/) template. There are some templates used for testing available [here](https://github.com/tomasbjerre/git-changelog/tree/master/src/test/resources/templates) and the results [here](https://github.com/tomasbjerre/git-changelog/tree/master/src/test/resources/assertions).
+
+Available in [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22se.bjurr.gitchangelog%22).
+
+## Usage
+This software can be used:
+ * As a library
+ * From command line
+
+### As a library
+
+It has a [builder](https://github.com/tomasbjerre/git-changelog/blob/master/src/main/java/se/bjurr/gitchangelog/api/GitChangelogApi.java) for creating the changelog.
+
+```
+  gitChangelogApiBuilder()
+   .withFromCommit(ZERO_COMMIT)
+   .withToRef("refs/heads/master")
+   .withTemplatePath("changelog.mustache")
+   .toFile("CHANGELOG.md");
+```
+
+It can also create releasenotes. If you are using git flow it may look like this.
+
+```
+  gitChangelogApiBuilder()
+   .withFromRef("refs/heads/dev")
+   .withToRef("refs/heads/master")
+   .withTemplatePath("releasenotes.mustache")
+   .toStdout();
+```
+
+### Command line
+Or from command line:
+```
+Arguments:
+-cl, --customIssueLink <string>            Custom issue link.
+                                           <string>: any string
+                                           Default: 
+-cn, --customIssueName <string>            Custom issue name.
+                                           <string>: any string
+                                           Default: 
+-cp, --customIssuePattern <string>         Custom issue pattern.
+                                           <string>: any string
+                                           Default: 
+-fc, --fromCommit <string>                 From commit.
+                                           <string>: any string
+                                           Default: 
+-fr, --fromRef <string>                    From ref.
+                                           <string>: any string
+                                           Default: 
+-gp, --githubPattern <string>              Github pattern.
+                                           <string>: any string
+                                           Default: 
+-gs, --githubServer <string>               Github server. When a Github server 
+                                           is given, the title of the Github 
+                                           issues can be used in the changelog.
+                                           <string>: any string
+                                           Default: 
+-h, --help <argument-to-print-help-for>    <argument-to-print-help-for>: an argument to print help for
+                                           Default: If no specific parameter is given the whole usage text is given
+-ip, --ignorePattern <string>              Ignore commits where pattern 
+                                           matches message.
+                                           <string>: any string
+                                           Default: 
+-jp, --jiraPattern <string>                Jira issue pattern.
+                                           <string>: any string
+                                           Default: 
+-js, --jiraServer <string>                 Jira server. When a Jira server is 
+                                           given, the title of the Jira issues can be 
+                                           used in the changelog.
+                                           <string>: any string
+                                           Default: 
+-of, --output-file <string>                Write output to file.
+                                           <string>: any string
+                                           Default: 
+-r, --repo <string>                        Repository.
+                                           <string>: any string
+                                           Default: 
+-sf, --settings-file <string>              Use settings from file.
+                                           <string>: any string
+                                           Default: 
+-std, --stdout                             Print builder to <STDOUT>.
+                                           Default: enabled
+-t, --template <string>                    Template to use. A default template 
+                                           will be used if not specified.
+                                           <string>: any string
+                                           Default: null
+-tc, --toCommit <string>                   To commit.
+                                           <string>: any string
+                                           Default: 
+-tr, --toRef <string>                      To ref.
+                                           <string>: any string
+                                           Default: 
+-ut, --untaggedName <string>               When listing commits per tag, this 
+                                           will by the name of a virtual tag that 
+                                           contains commits not available in any git 
+                                           tag.
+                                           <string>: any string
+                                           Default: null
+```
+
+## Developer instructions
+
+To build the code, have a look at `.travis.yml`.
+
+To do a release you need to do `./gradlew release` and release the artifact from [staging](https://oss.sonatype.org/#stagingRepositories). More information [here](http://central.sonatype.org/pages/releasing-the-deployment.html).
diff --git a/build.gradle b/build.gradle
@@ -16,7 +16,7 @@ apply plugin: 'signing'
 apply plugin: 'com.bmuschko.nexus'
 apply plugin: 'net.researchgate.release'
 
-group = 'se.bjurr.gitreleasenotes'
+group = 'se.bjurr.gitchangelog'
 
 mainClassName = 'se.bjurr.gitchangelog.main.Main'
 
@@ -51,14 +51,14 @@ sourceSets {
 
 modifyPom {
  project {
-  name 'GIT Release Notes'
-  description 'Library that generates release notes from a GIT repository.'
-  url 'https://github.com/tomasbjerre/git-release-notes'
+  name 'GIT Changelog'
+  description 'Library that generates changelog from a GIT repository.'
+  url 'https://github.com/tomasbjerre/git-changelog'
   inceptionYear '2015'
    scm {
-   url 'https://github.com/tomasbjerre/git-release-notes'
-   connection 'scm:https://tomasbjerre@github.com/tomasbjerre/git-release-notes.git'
-   developerConnection 'scm:git://github.com/tomasbjerre/git-release-notes.git'
+   url 'https://github.com/tomasbjerre/git-changelog'
+   connection 'scm:https://tomasbjerre@github.com/tomasbjerre/git-changelog.git'
+   developerConnection 'scm:git://github.com/tomasbjerre/git-changelog.git'
   }
 
   licenses {

diff --git a/tags-issues-authors-commits.mustache.md b/tags-issues-authors-commits.mustache.md