From 10a9ae0b59c8a14337c580db1d5c4a14c929b114 Mon Sep 17 00:00:00 2001 From: Georg Krause Date: Fri, 24 Jan 2020 16:01:58 +0100 Subject: [PATCH] Add usage info --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 551c11a..9b02dc7 100644 --- a/README.md +++ b/README.md @@ -17,3 +17,11 @@ go install ``` No the binary lives in `$GOPATH/bin`. Make sure, this is in your `$PATH`. + +## Usage + +The basic idea is to tell gott when you start and stop a task. In both cases you can specify tags which get added. So you can decide what fits better to your workflow. + +For example if you start coding now, type `gott start coding`. When you stop you know what you did and can give some additional info: `gott stop "implement xyz"`. Please note: When a tag should contain a whitespace, which is totally fine, put the string in double quotes. + +To view your records, simply use `gott list`.