diff options
| author | Zack Hobson | 2014-02-04 08:15:11 -0800 | 
|---|---|---|
| committer | Zack Hobson | 2014-02-04 08:16:25 -0800 | 
| commit | ef2aaa0bed393d3206b2bf0207c9c7f1b5e4b4a3 (patch) | |
| tree | bb6a8079c023c4f0f38ee0af0a08046e40ad63e9 | |
| parent | f2a4e5543eaa4024d69c271f820d34f29dc0578d (diff) | |
| download | hcl-ef2aaa0bed393d3206b2bf0207c9c7f1b5e4b4a3.tar.bz2 | |
add status command to docs
| -rw-r--r-- | README.markdown | 7 | ||||
| -rw-r--r-- | lib/hcl/app.rb | 6 | ||||
| -rw-r--r-- | man/hcl.1.ronn | 9 | 
3 files changed, 22 insertions, 0 deletions
| diff --git a/README.markdown b/README.markdown index d5fd7c0..ebe293c 100644 --- a/README.markdown +++ b/README.markdown @@ -35,6 +35,7 @@ or you can install from source:      hcl aliases      hcl (cancel | nvm | oops)      hcl config +    hcl status  ### Available Projects and Tasks @@ -175,6 +176,12 @@ commands show the time sheet for the specified day:  [cd]: http://chronic.rubyforge.org/ +Harvest provides an [status API], which you can query using the +`hcl status` command. This will tell you whether Harvest itself is up and the +current response time, along with a timestamp of when it was last tested. + +[status API]: http://harveststatus.com/status_api +  ## Author  HCl was designed and implemented by [Zack Hobson][zgh]. diff --git a/lib/hcl/app.rb b/lib/hcl/app.rb index 5c98452..0585dac 100644 --- a/lib/hcl/app.rb +++ b/lib/hcl/app.rb @@ -124,6 +124,12 @@ Commands:      # display the daily timesheet      hcl [show [<date>]] +    # show your current credentials +    hcl config + +    # display Harvest service status +    hcl status +  Examples:      hcl alias mytask 1234 4567      hcl @mytask +:15 Doing a thing that I started 15 minutes ago. diff --git a/man/hcl.1.ronn b/man/hcl.1.ronn index 10abb08..ac48d9b 100644 --- a/man/hcl.1.ronn +++ b/man/hcl.1.ronn @@ -15,6 +15,7 @@ hcl(1) -- Track time with Harvest time sheets      hcl aliases      hcl (cancel | nvm | oops)      hcl config +    hcl status  ## DESCRIPTION @@ -157,6 +158,14 @@ commands show the time sheet for the specified day:  [cd]: http://chronic.rubyforge.org/ +### Harvest service status + +Harvest provides an [status API], which you can query using the +`hcl status` command. This will tell you whether Harvest itself is up and the +current response time, along with a timestamp of when it was last tested. + +[status API]: http://harveststatus.com/status_api +  ## AUTHOR  HCl was designed and implemented by Zack Hobson. | 
