From 048928e99e32b31e70f0736b2ae84911825489c8 Mon Sep 17 00:00:00 2001 From: Paul Beckingham Date: Mon, 29 Feb 2016 11:09:22 -0500 Subject: [PATCH] Docs: Added basic clock examples --- doc/examples.txt | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/doc/examples.txt b/doc/examples.txt index 8f34bd09..7a532c59 100644 --- a/doc/examples.txt +++ b/doc/examples.txt @@ -1,10 +1,37 @@ Use Cases ========= -Simplest usage, as a clock: +This document contains a set of use cases and expected behavior. This will +gradually change into a feature spec. + + +[1.1] Basic Usage: clock +------------------------ +Using the 'start' and 'stop' commands without tags just records time intervals: $ timew start + ... $ timew stop +This results in a recorded interval with the 'default' tag. + + +[1.2] Basic Usage: clock + tags +------------------------------- +Using the 'start' and 'stop' commands with tags just records time intervals: + + $ timew start tag1 + ... + $ timew start tag2 + ... + $ timew stop + +This results in two consecutive recorded intervals with the 'tag1' and 'tag2' tags. +As these tags are not defined, there is no additional metadata. + + + + + This uses a 'default' tag. By using tags, this becomes: $ timew start tag1 # Start tracking now