aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2017-06-04 00:57:22 +0200
committerTeddy Wing2017-06-04 00:57:22 +0200
commitd0bb458eb592c76d1b1fed7b9ab692f9cb5b4838 (patch)
tree7225355836645c6b255ca73ebdfa3da8d962380b
parent161d11abfad116a219b490ad83e0a30461bcd455 (diff)
downloadtimetasker-d0bb458eb592c76d1b1fed7b9ab692f9cb5b4838.tar.bz2
README: Add Usage section
Show some examples of how to use the program.
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
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).