diff --git a/README.md b/README.md index 0acd80f..8b00d89 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,130 @@ A [timetrap](https://github.com/samg/timetrap/) compatible command line time tracking application. -## How to run +## Tutorial + +### Managing entries + +Register the start of an activity in the default timesheet with: + + t in 'Doing some coding' + +which sets the activity's start time to the current time. Later when you're done +use + + t out + +to mark it as finished. Both commands can be abbreviated to `t i` and `t o` +respectively. + +If you forgot to start the activity before you can do so with + + t i --at '20 min ago' + +the same applies for `t out`. + +Edit an entry with + + t edit [options] + +where the options are + + -i, --id Alter entry with id instead of the running entry + -s, --start Change the start time to