diff options
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 24 |
1 files changed, 22 insertions, 2 deletions
diff --git a/README.markdown b/README.markdown index 8903b1c..7151b92 100644 --- a/README.markdown +++ b/README.markdown @@ -3,23 +3,43 @@ HCl is a command-line tool for interacting with Harvest time sheets using the [Harvest time tracking API][1]. +## Quick Start + +NOTE This software is nowhere near complete. Currently the only implemented +feature is a simple view of today's timesheet. To try it out: + + $ cp hcl_conf.yml.example hcl_conf.yml + $ $EDITOR hcl_conf.yml + $ ./bin/hcl show + +### Prerequisites + +This software depends on the Curb gem. To install: + + $ sudo gem install curb + ## Usage + hcl [opts] show [date] hcl [opts] add <project> <task> <duration> [msg] hcl [opts] rm [entry_id] hcl [opts] start <project> <task> [msg] hcl [opts] stop [msg] - hcl [opts] show [date] ## TODO * Implement time-tracking API methods: - - get daily time sheet + - display today's time sheet (done) + - display any time sheet by date - get time sheet entry - toggle a timer - post a time sheet entry - delete a time sheet entry - update a time sheet entry + * command-line configuration + * search ~/.hcl_config for configuration + * integrate timesheet functionality into aiaio's [harvest gem][2] [1]: http://www.getharvest.com/api/time_tracking +[2]: http://github.com/aiaio/harvest/tree/master |