rea

readme

display a module's readme in the terminal

Showing:

Popularity

Downloads/wk

17

GitHub Stars

61

Maintenance

Last Commit

3yrs ago

Contributors

8

Package

Dependencies

20

Size (min+gzip)

95.1KB

License

BSD-2-Clause

Type Definitions

Tree-Shakeable

No?

Categories

Readme

readme

Retrieve a node module's readme from the command line, and pipe it into less.

Installation

> npm install readme -g

Usage

Show the readme for a node module.

readme resolves your module in the same way as require()

> readme          # for the current module.

> readme optimist # for a locally installed module

> readme readme -g # for a globally installed module.

> readme -c http   # for a core module

> readme readme --web # open the project's webpage

> readme readme --gh # open the projects github page

Shell completions

readme comes with completions for the Fish shell (completions for other shells welcome).

To install completions, put completions/readme.fish file to a directory listed in $fish_complete_path.

$ curl -L https://raw.github.com/dominictarr/readme/master/completions/readme.fish >~/.config/fish/completions/readme.fish

License

BSD

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial