diff options
| author | Zack Hobson | 2013-11-18 12:20:08 -0800 | 
|---|---|---|
| committer | Zack Hobson | 2013-11-18 12:20:08 -0800 | 
| commit | 392034ccb82add25c97c8175abbc6422aa871b27 (patch) | |
| tree | 0a95069bd1de35d0b51dd4de0ef775cb53421f71 /README.markdown | |
| parent | 27bc3cef233dd4f50c9957bae0ac90392ea99023 (diff) | |
| download | hcl-392034ccb82add25c97c8175abbc6422aa871b27.tar.bz2 | |
version 0.4.0
* added alias and unalias commands
* note and start commands are now optional/contextual
* note adds a new line
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 44 | 
1 files changed, 23 insertions, 21 deletions
| diff --git a/README.markdown b/README.markdown index b444237..d3e5da6 100644 --- a/README.markdown +++ b/README.markdown @@ -40,51 +40,53 @@ or you can install from source using jeweler:      hcl stop [msg]      hcl resume -### Starting a Timer +### Available Projects and Tasks  To start a new timer you need to identify the project and task. After you've  used the show command you can use the tasks command to view a cached list of -available tasks. The first two numbers in each row are the project and task -IDs. You need both values to start a timer: +available tasks. -    $ hcl show -    ------------- -    0:00    total      $ hcl tasks -    1234 5678   ClientX Software Development -    1234 9876   ClientX Admin -    $ hcl start 1234 5678 adding a new feature -### Task Aliases +### Starting a Timer  Since it's not practical to enter two long numbers every time you want to -identify a task, HCl supports task aliases. The task alias must start with 'task.', followed by your alias. +identify a task, HCl supports task aliases: -    $ hcl set task.xdev 1234 5678 -    $ hcl start xdev adding a new feature +    $ hcl alias xdev 1234 5678 +    $ hcl @xdev Adding a new feature!  ### Starting a Timer with Initial Time  You can also provide an initial time when starting a new timer.  This can be expressed in floating-point or HH:MM. The following two -commands are identical: +commands are equivalent: -    $ hcl start xdev +0:15 adding a new feature -    $ hcl start +.25 xdev adding a new feature +    $ hcl @xdev +0:15 Adding a new feature! +    $ hcl +.25 @xdev Adding a new feature!  ### Adding Notes to a Running Task -While a task is running you can append strings to the note for that task: +While a task is running you can append lines to the task notes. +Providing the note command is optional, just the bare message will work. +These two commands are equivalent: -    $ hcl note Found a good time -    $ hcl note or not, whatever... +    $ hcl Found a good time! +    $ hcl note Found a good time!  ### Stopping a Timer  The following command will stop a running timer (currently only one timer at -a time is supported): +a time is supported). You can provide a message when stopping a timer as +well: + +    $ hcl stop All done! + +### Resuming a Timer + +You can easily resume the last stopped timer: -    $ hcl stop +    $ hcl resume  ### Date Formats | 
