YY.MM versioning FTW

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..f93f234
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# git-chart
+
+`git-chart` is a simple Perl script that generates a plot of commits over time
+for a given repository. This was created as a quick&dirty hack, so expect rough
+edges and lots of missing features.
+
+Also note that it was developed independently and bears no relation to [flashcode's
+gitchar](https://github.com/flashcode/gitchart) program, despite the similarity
+in name and intent.
+
+# Usage
+
+       Usage: git chart [options...] [log specs...]
+
+       Creates a chart plotting the distribution over time of the commits
+       specified as <log specs>. By default, commits are grouped by hour, day,
+       week, month or year depending on the time spanned, but this can be
+       controlled by the user.
+
+       Options:
+               --hourly, --daily, --weekly, --monthly, --yearly:
+                       force a specific commit grouping
+               --step=<integer>:
+                       force commits to be grouped each <integer> seconds
+               --gnuplot:
+                       produce a chart with gnuplot (default)
+               --google:
+                       produce a chart with Google Charts
+               --chart-height=<integer>:
+                       set the Google Charts height; the width is set
+                       to a 4:3 ratio (default: 100)
+

diff --git a/git-chart b/git-chart
index ebe1662..661dd7a 100755 (executable)
--- a/git-chart
+++ b/git-chart
@@ -23,6 +23,8 @@ use File::Spec;
 use File::Temp;
 use List::Util 'max';
 
+our $VERSION = '17.04';
+
 my $SECS_PER_DAY = 24*3600;
 
 my %steps = (