readman

Display local package readme as a man page.

Like readme, but renders readme into a full-fledged man page.

Usage

Display readme for installed package:

$ npm install express
$ readman express

Display readme for package at current working directory:

$ readman

Display readme for global package:

$ readman -g npm

CLI

$ readman [--global | -g] [<module>]

Displays man page for <module> (requiring it through the usual Node require.resolve algorithm) or for module at the current directory (stepping up into parent directories if needed).

With -g flag, module name is resolved globally instead of locally.

Related

readman is basically a hybrid of these two packages:

• readme: display local package readme in Markdown.
• npm-man: display any package readme from npm registry (over the network).

Install

npm install -g readman

License

MIT