aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTeddy Wing2017-06-04 01:55:00 +0200
committerTeddy Wing2017-06-04 01:55:00 +0200
commitbd8fff1d37a48e8fba4559f7fd34f6c2af507806 (patch)
treee07cab321fb9086de721af40ef3b5a5f0cf3494f /README.md
parentb7f6ee30221f208a3505b03390d6e9f0431c448e (diff)
downloadtimetasker-bd8fff1d37a48e8fba4559f7fd34f6c2af507806.tar.bz2
README: Add an additional Usage example
I thought it would be cool if we showed off an example connecting `timetasker` with another shell command.
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index f137a08..a981d56 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,15 @@ Now we specify a date and add a description:
$ timetasker --project example --date 2017-05-31 --description "Worked on Timetasker"
+And because it's a shell command, we can combine it with other commands. Let's
+create a week's worth of time entries starting on Monday May 29th, 2017:
+
+ $ for d in $(ruby -e "require 'date'
+ > d = Date.new(2017, 5, 29)
+ > (0..4).each { |i| puts (d + i).strftime('%Y-%m-%d') }");
+ > do timetasker --project example --date $d;
+ > done
+
## Configuration
Timetasker relies on a configuration file in order to work properly.