From e80592f03c4dde2e7a4410652fe2a27119a56820 Mon Sep 17 00:00:00 2001 From: Tomasz Gieniusz Date: Wed, 25 Jun 2014 20:12:39 +0200 Subject: [PATCH] updated readme with new cli parameters names --- README.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 870e110b9..fe1860f7d 100644 --- a/README.md +++ b/README.md @@ -34,20 +34,22 @@ It browses the repository and outputs html page with statistics. git_stats generate Options: - p, [--path=PATH] # Path to repository from which statistics should be generated. - # Default: . - o, [--out-path=OUT_PATH] # Output path where statistics should be written. - # Default: ./git_stats - l, [--language=LANGUAGE] # Language of written statistics. - # Default: en - f, [--from=FROM] # Commit from where statistics should start. - t, [--to=TO] # Commit where statistics should stop. - # Default: HEAD - s, [--silent], [--no-silent] # Silent mode. Don't output anything. - d, [--tree=TREE] # Tree where statistics should be generated. - # Default: . - c, [--comment=COMMENT] # The string which is used for comments. - # Default: // + p, [--path=PATH] # Path to repository from which statistics should be generated. + # Default: . + o, [--out-path=OUT_PATH] # Output path where statistics should be written. + # Default: ./git_stats + l, [--language=LANGUAGE] # Language of written statistics. + # Default: en + f, [--first-commit-sha=FIRST_COMMIT_SHA] # Commit from where statistics should start. + t, [--last-commit-sha=LAST_COMMIT_SHA] # Commit where statistics should stop. + # Default: HEAD + s, [--silent], [--no-silent] # Silent mode. Don't output anything. + d, [--tree=TREE] # Tree where statistics should be generated. + # Default: . + c, [--comment-string=COMMENT_STRING] # The string which is used for comments. + # Default: // + + Generates the statistics of a repository