Docstring

git_time_tracker/__init__.py

@@ -1,3 +1,30 @@
+"""# Git-based Time Tracker.
+
+Quick and dirty time tracker on git histories.
+
+Uses the simple heuristics that each commit takes precisely one hour of work.
+It will automatically trim commits below one hour if another commit occurred
+less than an hour ago.
+
+Usage:
+
+```
+python -m git_time_tracker REPO1 REPO2...
+```
+
+# Obligatory
+
+This tool reports:
+
+```
+project    Jmaa/git-time-tracker.git                    3h 33m  (2024)
+```
+
+And the ([Hamster](https://github.com/projecthamster/hamster)) manual time tracker reports:
+
+![](docs/obligatory-hamster.png)
+"""
+
 import argparse
 import dataclasses
 import datetime