GothenburgBitFactory/timewarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/timewarrior.git synced 2025-07-07 20:06:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Docs: Added basic clock examples

Browse source
This commit is contained in:
Paul Beckingham 2016-02-29 11:09:22 -05:00
parent 6f18668543
commit 048928e99e
1 changed files with 28 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

29
doc/examples.txt
View file

@ -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