diff --git a/README.md b/README.md index dd14e5c..a297481 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,37 @@ -# zeit -Zeit. +zeit +---- + +Zeit erfassen. A command line tool for tracking time spent on tasks & projects. + +## Build + +``` +make +``` + +## Usage + +### Start tracking + +``` +zeit track --help +``` + +Example: + +``` +zeit track --project project --task task --begin -0:15 +``` + +### Finish tracking + +``` +zeit finish --help +``` + +Example: + +``` +zeit finish +``` +