summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorZack Hobson2009-07-16 12:06:09 -0700
committerZack Hobson2009-07-16 12:15:12 -0700
commita2a00500c02e1ecb6e57e444a468786d8de3f9d8 (patch)
treec6cc6f210f180860a1ca915e3619408a3260e5e3
parent86bdc46f090ddee08771f519eb8570cb4f9f4220 (diff)
downloadhcl-a2a00500c02e1ecb6e57e444a468786d8de3f9d8.tar.bz2
updated README documentation
-rw-r--r--README.markdown24
-rw-r--r--lib/hcl.rb4
2 files changed, 24 insertions, 4 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
diff --git a/lib/hcl.rb b/lib/hcl.rb
index 5b8abba..c9fcf94 100644
--- a/lib/hcl.rb
+++ b/lib/hcl.rb
@@ -6,7 +6,7 @@ require 'curb'
require 'hcl/day_entry'
class HCl
- class UnknownCommand < RuntimeError; end
+ class UnknownCommand < StandardError; end
def self.command *args
command = args.shift
@@ -18,7 +18,7 @@ class HCl
if hcl.respond_to? command
hcl.send command
else
- raise UknownCommand, "unrecognized command `#{command}'"
+ raise UnknownCommand, "unrecognized command `#{command}'"
end
end