diff options
| author | Zack Hobson | 2009-08-23 21:48:27 -0700 |
|---|---|---|
| committer | Zack Hobson | 2009-08-23 21:48:27 -0700 |
| commit | 7951e8cd378f5dc65deddbd6268695fdfc42b40b (patch) | |
| tree | b65849ba3cc93a8be88b538e3515fa6562082742 | |
| parent | 0c035b57e8be8a940672dca9d7bd7f784935d6ec (diff) | |
| download | hcl-7951e8cd378f5dc65deddbd6268695fdfc42b40b.tar.bz2 | |
Added some info from the README.
| -rw-r--r-- | index.markdown | 94 |
1 files changed, 92 insertions, 2 deletions
diff --git a/index.markdown b/index.markdown index 1a5cb79..5356d19 100644 --- a/index.markdown +++ b/index.markdown @@ -11,12 +11,102 @@ See [github.com/zenhob/hcl][hcl] for details. [htt]: http://www.getharvest.com/api/time_tracking [hcl]: http://github.com/zenhob/hcl +## Quick Start + + $ gem install zenhob-hcl --source=http://gems.github.com + $ hcl show [date] + +### Prerequisites + + * Ruby (tested with 1.8.7) + * Ruby OpenSSL support (in debian/ubuntu: apt-get install libopenssl-ruby) + * Ruby extension building support (in debian/ubuntu: apt-get install ruby-dev) + * RubyGems + * Trollop option-parsing library (gem install trollop) + * Chronic date-parsing library (gem install chronic) + * HighLine console input library (gem install highline) + * Jeweler packaging tool (needed to build the gem) + +## Usage + + hcl show [date] + hcl tasks + hcl set <key> <value ...> + hcl unset <key> + hcl start (<task_alias> | <project_id> <task_id>) [+time] [msg ...] + hcl note <msg ...> + hcl stop + +### Starting a Timer + +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: + + $ 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 + +Since it's not practical to enter two long numbers every time you want to +identify a task, HCl supports task aliases: + + $ hcl set task.xdev 1234 5678 + $ hcl start 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: + + $ hcl start xdev +0:15 adding a new feature + $ hcl start +.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: + + $ hcl note Found a good time + $ hcl note or not, whatever... + +### 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][cd] +for more information about available date input formats. The following +commands show the timesheet for the specified day: + + $ hcl show yesterday + $ hcl show last friday + $ hcl show 2 days ago + $ hcl show 1 week ago + +[cd]: http://chronic.rubyforge.org/ + +## Reporting Bugs + +HCl is still very early in development and probably has some bugs. +If you find a bug in HCl please file it using the [issue tracker][it]. + +[it]: http://github.com/zenhob/hcl/issues + ## Author [Zack Hobson][zgh], [OpenSourcery LLC][os] -See LICENSE for copyright details. - [zgh]: mailto:zack@opensourcery.com [os]: http://www.opensourcery.com/ |
