From 3c1cd4d7d94c385c58e1468fa2cebc519a5990ae Mon Sep 17 00:00:00 2001 From: Daniel Flower Date: Mon, 19 Sep 2011 22:15:37 +0800 Subject: [PATCH] Added links to example reports --- README.md | 10 +++++++++- maven-gitlog-plugin.iml | 3 --- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9070c18..c7da467 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,16 @@ This plugin allows the creation of text and HTML changelogs based on the git log phase this plugin can generate plaintext and HTML reports showing all the commits (with tags) from the local git repository. These text files can then be sent to a web server or included during packaging. +Sample output +============= + +Using the default plugin parameters, the changelog for this project looks like the following: + +[HTML example](http://danielflower.github.com/maven-gitlog-plugin/samples/changelog.html) +[Text example](http://danielflower.github.com/maven-gitlog-plugin/samples/changelog.txt) + Configuring the plugin ----------------------- +====================== Add the following to your `` section in your pom.xml file to generate changelog.txt and changelog.html in your target folder: diff --git a/maven-gitlog-plugin.iml b/maven-gitlog-plugin.iml index fea15a7..94b6273 100644 --- a/maven-gitlog-plugin.iml +++ b/maven-gitlog-plugin.iml @@ -12,10 +12,7 @@ - - -