From d0bb458eb592c76d1b1fed7b9ab692f9cb5b4838 Mon Sep 17 00:00:00 2001 From: Teddy Wing Date: Sun, 4 Jun 2017 00:57:22 +0200 Subject: README: Add Usage section Show some examples of how to use the program. --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 5c4cd42..1d0b99e 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,21 @@ extension](https://github.com/teddywing/chrome-timetasker) that auto-fills the time sheet form on the website. +## Usage +This will submit a time entry for the "example" project on the current day with +a duration of 7 hours and an empty description: + + $ timetasker --project example + +Here we set a custom time of 4.5 hours: + + $ timetasker --project example --time 4.5 + +Now we specify a date and add a description: + + $ timetasker --project example --date 2017-05-31 --description "Worked on Timetasker" + + ## License Copyright © 2017 Teddy Wing. Licensed under the GNU GPLv3+ (see the included COPYING file). -- cgit v1.2.3