manpages 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ab7800ca095338322550d7af194a1c438cf6e15
-  data.tar.gz: c614993dc6ee596338851261ccfa32fe811ed06d
+  metadata.gz: 004f3ea0f6975be144e959a07a1e675ca74f0a74
+  data.tar.gz: 214fdd72a12baa995026e39886663936ca163809
 SHA512:
-  metadata.gz: 14886da88e27fd091701ab9903b4ed81ef8b3fb55f3ef75034675e6c196071beb5767b727ad2ac5606cb7caa0f8edf140a74be8560a868ff7e3178c9806b61bc
-  data.tar.gz: 50eca018decc731ca8c55638e3308141a6821cb4fabca3e5e99b4674295582ae1ed4488b8075603b7ab8f8209cacc5f50e0b541b30225609daa8c6e8ba952a94
+  metadata.gz: a044a4fbb40dc96cf9991f9c60e45829f5f0454ad7a68684612e850c4188d854d75547ba6e8a6fdad727d72f1bc0e6cddef42a1a160d967ececed6098be8cc3f
+  data.tar.gz: 062589cd697b53156be38eb97d9f329a91ee2509b866d5710157263749544cee26b5bedffdd55765177db4ceedc82b09b946eba31e1a1557d726bb97707979f1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    manpages (0.2.2)
+    manpages (0.3.1)
 
 GEM
   remote: https://rubygems.org/
@@ -40,4 +40,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.13.2
+   1.13.6

data/README.md

@@ -5,32 +5,48 @@
 
 This plugin will add man pages support to ruby gems. Instead 
 of adding a new command like [gem-man](https://github.com/defunkt/gem-man)
-it will try to link the files to place that the `man` command can find.
+it will try to link the files to a place the `man` command automatically
+discovers.
 
-With rvm and chruby it works out of the box, but sadly for rbenv we need to add
-hooks that modify the `MANPATH` depending on the ruby version currently used.
+With rvm and chruby it works out of the box, but sadly for rbenv we need to [add
+hooks that](#using-this-with-rbenv) modify the `MANPATH` depending on the ruby version currently used.
 
 # Installation
 
 `gem install manpages`
 
-This plugin automatically hooks into the ruby gems system.
+This plugin automatically hooks into the ruby gems system. Every gem
+installed afterwards is checked for manpages. If this gem finds them, it
+exposes them to the `man` command.
+
+# Using this with rbenv
+
+Sadly rbenv uses shims to hide the actual executables. This makes it impossible for
+man to find the pages. The only solution is to add hooks that modify the `MANPATH`
+environment variable.
+
+This gem will [soon](https://github.com/bitboxer/manpages/issues/2) provide a hook to fix this problem.
 
 # How this works
 
-After a gem is installed, this plugin will check for a directory called `man` and
-will link the manpages it finds to `BIN_DIR/../share/man`, where `BIN_DIR` is the
+After a gem is installed, this plugin will check for a directory called `man` within the 
+gem and link the manpages it finds to `BIN_DIR/../share/man`, where `BIN_DIR` is the
 directory where the executable of the gem is installed.
 
 Most man versions will automatically search this directory and no additional work
-is required. So if you install a gem that includes a man page (e.g. guard), you can
+is required. If you install a gem that includes a man page (e.g. [guard](https://github.com/guard/guard)), you can
 simply use `man guard` and you will see the man page the gem provided.
 
-# Using this with rbenv
+# Providing man pages with your gem
 
-Sadly rbenv uses shims to hide the actual executables. This makes it impossible for
-man to find the pages. The only solution is to add hooks that modify the `MANPATH`
-environment variable.
+The most common way in the ruby world to create a man page is through a tool
+called [ronn](https://github.com/rtomayko/ronn#readme). Ronn uses a modified
+variant of markdown as source file. More details about the format can be found
+[here](https://github.com/rtomayko/ronn/blob/master/man/ronn-format.7.ronn).
 
-This gem will provide a hook soon to fix this issue.
+Make sure the resulting manpage is in a folder called `man` in the root of the
+gem. Files stored in that directory will automatically be exposed to the
+`man` command.
 
+Examples for gems with manpages are [guard](https://github.com/guard/guard/tree/master/man) or
+[gem-man](https://github.com/defunkt/gem-man/tree/master/man).

data/lib/manpages/version.rb

@@ -1,3 +1,3 @@
 module Manpages
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manpages
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Bodo Tasche
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-28 00:00:00.000000000 Z
+date: 2016-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler