summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Gemfile.lock2
-rw-r--r--README.markdown8
-rw-r--r--hcl.gemspec1
3 files changed, 11 insertions, 0 deletions
diff --git a/Gemfile.lock b/Gemfile.lock
index f687b79..e2bbc8c 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -5,6 +5,7 @@ PATH
chronic (~> 0.10.2)
escape_utils (~> 1.0.1)
faraday (~> 0.9.0)
+ gem-man (~> 0.3.0)
highline (~> 1.6.20)
pry (~> 0.9.12)
trollop (~> 2.0)
@@ -21,6 +22,7 @@ GEM
faraday (0.9.0)
multipart-post (>= 1.2, < 3)
ffi (1.9.3-java)
+ gem-man (0.3.0)
highline (1.6.20)
hpricot (0.8.6)
hpricot (0.8.6-java)
diff --git a/README.markdown b/README.markdown
index 373cd03..6a2ea45 100644
--- a/README.markdown
+++ b/README.markdown
@@ -21,6 +21,14 @@ or you can install from source:
rake install
+Once installed, you can view this README as a man page:
+
+ gem man hcl
+
+I recommend aliasing your `man` command to additionally load gem man pages:
+
+ alias man="gem man -ls"
+
## SYNOPSIS
hcl [start] @<task_alias> [+<time>] [<message>]
diff --git a/hcl.gemspec b/hcl.gemspec
index ab61793..acc5985 100644
--- a/hcl.gemspec
+++ b/hcl.gemspec
@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
s.licenses = ["MIT"]
s.summary = "Harvest timesheets from the command-line"
+ s.add_runtime_dependency 'gem-man', '~>0.3.0'
s.add_runtime_dependency 'trollop', '~>2.0'
s.add_runtime_dependency 'chronic', '~>0.10.2'
s.add_runtime_dependency 'highline', '~>1.6.20'