Update README.md

CHANGELOG.md

@@ -0,0 +1,38 @@
+# Git Changelog changelog
+
+Changelog of Git Changelog.
+
+## Unreleased
+### No issue
+
+**Update README.md**
+
+
+[d2da496ed772fd4](https://github.com/tomasbjerre/git-changelog-lib/commit/d2da496ed772fd4) Tomas Bjerre *2016-02-21 12:27:49*
+
+**JSHint and PMD parsers**
+
+
+[48773067b5e86d1](https://github.com/tomasbjerre/git-changelog-lib/commit/48773067b5e86d1) Tomas Bjerre *2016-02-21 12:18:13*
+
+**Findbugs parser**
+
+
+[395483a7117cdb7](https://github.com/tomasbjerre/git-changelog-lib/commit/395483a7117cdb7) Tomas Bjerre *2016-02-21 11:42:53*
+
+**Adding specifics and column to Violation**
+
+
+[d6e0920176a6d9f](https://github.com/tomasbjerre/git-changelog-lib/commit/d6e0920176a6d9f) Tomas Bjerre *2016-02-21 08:33:00*
+
+**Parsers and sample reports**
+
+
+[b8d5a66e8ec407c](https://github.com/tomasbjerre/git-changelog-lib/commit/b8d5a66e8ec407c) Tomas Bjerre *2016-02-20 21:40:52*
+
+**First commit**
+
+
+[f141f3565174869](https://github.com/tomasbjerre/git-changelog-lib/commit/f141f3565174869) Tomas Bjerre *2016-02-18 18:17:50*
+
+

README.md

@@ -2,6 +2,22 @@
 
 This is a library for parsing report files from static code analyzis.
 
+It supports:
+ * [_PMD_](https://pmd.github.io/)
+ * [_Findbugs_](http://findbugs.sourceforge.net/)
+ * [_Checkstyle_](http://checkstyle.sourceforge.net/)
+ * [_CSSLint_](https://github.com/CSSLint/csslint)
+ * [_JSHint_](http://jshint.com/)
+
+Very easy to use with a nice builder patternn
+```
+  List<Violation> actual = violationsApi() //
+    .withPattern(".*/findbugs/.*\\.xml$") //
+    .inFolder(rootFolder) //
+    .findAll(FINDBUGS) //
+    .violations();
+```
+
 ## Developer instructions
 
 To build the code, have a look at `.travis.yml`.

build.gradle

@@ -1,10 +1,14 @@
 buildscript {
  repositories {
   jcenter()
+  maven {
+   url "https://plugins.gradle.org/m2/"
+  }
  }
  dependencies {
   classpath 'com.bmuschko:gradle-nexus-plugin:2.3.1'
   classpath 'net.researchgate:gradle-release:2.2.2'
+  classpath "gradle.plugin.se.bjurr.gitchangelog:git-changelog-gradle-plugin:1.21"
  }
 }
 
@@ -14,6 +18,12 @@ apply plugin: 'eclipse'
 apply plugin: 'signing'
 apply plugin: 'com.bmuschko.nexus'
 apply plugin: 'net.researchgate.release'
+apply plugin: "se.bjurr.gitchangelog.git-changelog-gradle-plugin"
+
+task gitChangelogTask(type: se.bjurr.gitchangelog.plugin.gradle.GitChangelogTask) {
+ filePath = "CHANGELOG.md";
+ templateContent = new File('changelog.mustache').getText('UTF-8');
+}
 
 group = 'se.bjurr.violations'
 

changelog.mustache

@@ -0,0 +1,32 @@
+# Git Changelog changelog
+
+Changelog of Git Changelog.
+
+{{#tags}}
+## {{name}}
+ {{#issues}}
+  {{#hasIssue}}
+   {{#hasLink}}
+### {{name}} [{{issue}}]({{link}}) {{title}}
+   {{/hasLink}}
+   {{^hasLink}}
+### {{name}} {{issue}} {{title}}
+   {{/hasLink}}
+  {{/hasIssue}}
+  {{^hasIssue}}
+### {{name}}
+  {{/hasIssue}}
+
+  {{#commits}}
+**{{{messageTitle}}}**
+
+{{#messageBodyItems}}
+ * {{.}} 
+{{/messageBodyItems}}
+
+[{{hash}}](https://github.com/tomasbjerre/git-changelog-lib/commit/{{hash}}) {{authorName}} *{{commitTime}}*
+
+  {{/commits}}
+
+ {{/issues}}
+{{/tags}}