From f157457c297a606057fcb899255cb2b6c4f6a322 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=9E=E3=83=AA=E3=82=A6=E3=82=B9?= Date: Thu, 15 Oct 2020 00:50:05 +0100 Subject: [PATCH] Extended README.md --- README.md | 39 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) 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 +``` +