summaryrefslogtreecommitdiffstats
path: root/README.markdown
diff options
context:
space:
mode:
authorZack Hobson2013-12-27 13:19:57 -0800
committerZack Hobson2013-12-27 13:19:57 -0800
commit8e2e788909c6a634976c80eeb75c79af8f8ab734 (patch)
tree8314e9ad539476d0e327ad20abde667203f4115f /README.markdown
parent89867bd84610d6d5622540a7e26b6c3467d632bf (diff)
downloadhcl-8e2e788909c6a634976c80eeb75c79af8f8ab734.tar.bz2
pass http client into instance commands
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.markdown b/README.markdown
index 4b05856..d6fe847 100644
--- a/README.markdown
+++ b/README.markdown
@@ -144,17 +144,19 @@ powerful Harvest API client built into HCl, since not all of its
features are exposed via the command line. The current {HCl::App}
instance is available as `hcl`.
-It's also possible to issue HCl commands directly (as Ruby methods), or
-to query specific JSON end points and have the results pretty-printed:
+It's also possible to issue HCl commands directly (except `alias`, see
+below), or to query specific JSON end points and have the results
+pretty-printed:
hcl console
hcl> show "yesterday"
# => prints yesterday's timesheet, note the quotes!
- hcl> Net.get('daily')
+ hcl> hcl.http.get('daily')
# => displays a pretty-printed version of the JSON output
-Note that unlike the commands themselves, the HCl internals may change without
-notice.
+Note that the the HCl internals may change without notice.
+Also, commands (like `alias`) that are also reserved words in Ruby
+can't be issued directly (use `send :alias` instead).
### Date Formats