https://github.com/dominictarr/readme

https://github.com/dominictarr/readme

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/dominictarr/readme
• Owner: dominictarr
• Created: 2012-07-21T10:51:06.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2018-07-24T04:42:51.000Z (almost 6 years ago)
• Last Synced: 2024-05-11T07:47:55.695Z (about 1 month ago)
• Language: JavaScript
• Size: 44.9 KB
• Stars: 62
• Watchers: 4
• Forks: 14
• Open Issues: 2
• Metadata Files:
  • Readme: readme.markdown

Lists

• awesome-reference-tools - readme - Retrieve a node module's readme from the command line, and pipe it into less (Uncategorized / Uncategorized)

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](http://opensource.org/licenses/BSD-2-Clause)