From 96a66757dbfbc55393e6310ed9da5bffa3852d2d Mon Sep 17 00:00:00 2001
From: Otto Radics <otto@webmenedzser.hu>
Date: Fri, 11 May 2018 08:11:28 +0200
Subject: [PATCH] GitStat converter documentation

Documents https://github.com/geryxyz/CodeMetropolis/pull/115
---
 toolchain/converter/index.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/toolchain/converter/index.md b/toolchain/converter/index.md
index b9c1d1f6..34314fe3 100644
--- a/toolchain/converter/index.md
+++ b/toolchain/converter/index.md
@@ -55,6 +55,19 @@ To build a city with separated directories, the following command should be give
 
 `java -jar converter.jar -t sonarqube -i <serverName> -o <outputFilename> -p projects=<projectname> splitDirs=true`
 
+# GitStats CDF converter
+
+This application scans and retrieves usable statistic information from the GitStats git repository statistics generator. It uses the gitstats as type to parse the html and dat files from the given input folder. 
+
+**Usage**: `java -jar converter.jar -t <type> -i <input path> [-o <output.xml>]`
+
+* `-i`: input, the path of the folder generated by GitStats. Required.
+* `-o`: output, the path of the output XML file. Optional. 
+* `-t`: type, the type of the conversion. In this case it will be ‘gitstats’. Required. 
+
+After execution the tool will generate a Converter output xml which contains git statistics elements like line of code, commits, committed files group by extension with properties of dates.
+
+
 # About the output XML
 
 The output XML contains the name and the type of the elements and the properties of them.