summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorZack Hobson2011-07-13 00:08:50 -0700
committerZack Hobson2011-07-13 00:08:50 -0700
commit711585fc5547b75e865028ba51f5d0b9669a28a6 (patch)
treec5f6bc244ddbe67d0cd1cf5b36d33088b52311da
parent6a31581e326b4303db4c483358efa6dc36015211 (diff)
downloadhcl-711585fc5547b75e865028ba51f5d0b9669a28a6.tar.bz2
tweak README
-rw-r--r--README.markdown12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.markdown b/README.markdown
index 4877a66..0379dcc 100644
--- a/README.markdown
+++ b/README.markdown
@@ -7,18 +7,22 @@ HCl is a command-line tool for interacting with Harvest time sheets using the
## Quick Start
-You can install hcl from Gemcutter:
+You can install hcl directly from rubygems.org:
$ gem install hcl
$ hcl show [date]
+or you can install from source using jeweler:
+
+ $ gem install jeweler
+ $ rake install
+
### 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 1.3.3
- * Gemcutter (gem install gemcutter; gem tumble)
* Trollop option-parsing library (gem install trollop)
* Chronic date-parsing library (gem install chronic)
* HighLine console input library (gem install highline)
@@ -32,7 +36,9 @@ You can install hcl from Gemcutter:
hcl unset <key>
hcl start (<task_alias> | <project_id> <task_id>) [+time] [msg ...]
hcl note <msg ...>
- hcl stop
+ hcl aliases
+ hcl stop [msg]
+ hcl resume
### Starting a Timer