summaryrefslogtreecommitdiffstats
path: root/README.markdown
diff options
context:
space:
mode:
authorZack Hobson2009-07-21 10:53:43 -0700
committerZack Hobson2009-07-21 10:53:43 -0700
commit30239dc8f61b86335eb8a4de9bdbbe38b425aa0b (patch)
tree45688ede37e2a57bb7685d4bebb7e978b9e73bbe /README.markdown
parent538986dd21356b248806fc979998caa64cdedb50 (diff)
downloadhcl-30239dc8f61b86335eb8a4de9bdbbe38b425aa0b.tar.bz2
Added stop command, closes #5.
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.markdown b/README.markdown
index 4067be9..f1e4ccc 100644
--- a/README.markdown
+++ b/README.markdown
@@ -20,16 +20,16 @@ NOTE This software is nowhere near complete. To try it out:
## Usage
-NOTE that /add/, /rm/ and /stop/ are not yet implemented.
+NOTE that /add/ and /rm/ are not yet implemented.
hcl show [date]
hcl tasks
hcl set <key> <value ...>
hcl unset <key>
hcl start (<task_alias> | <project_id> <task_id>) [msg]
+ hcl stop
hcl add (<task_alias> | <project_id> <task_id>) <duration> [msg]
hcl rm [entry_id]
- hcl stop [msg]
### Starting a Timer
@@ -54,6 +54,13 @@ identify a task, HCl supports task aliases:
$ hcl set task.xdev 1234 5678
$ hcl start xdev adding a new feature
+### Stopping a Timer
+
+The following command will stop a running timer (currently only one timer at
+a time is supported):
+
+ $ hcl stop
+
### Date Formats
Dates can be expressed in a variety of ways. See the [Chronic documentation][2]