• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# bin-links [![npm version](https://img.shields.io/npm/v/bin-links.svg)](https://npm.im/bin-links) [![license](https://img.shields.io/npm/l/bin-links.svg)](https://npm.im/bin-links) [![Travis](https://img.shields.io/travis/npm/bin-links.svg)](https://travis-ci.org/npm/bin-links) [![AppVeyor](https://ci.appveyor.com/api/projects/status/github/npm/bin-links?svg=true)](https://ci.appveyor.com/project/npm/bin-links) [![Coverage Status](https://coveralls.io/repos/github/npm/bin-links/badge.svg?branch=latest)](https://coveralls.io/github/npm/bin-links?branch=latest)
2
3[`bin-links`](https://github.com/npm/bin-links) is a standalone library that links
4binaries and man pages for Javascript packages
5
6## Install
7
8`$ npm install bin-links`
9
10## Table of Contents
11
12* [Example](#example)
13* [Features](#features)
14* [Contributing](#contributing)
15* [API](#api)
16  * [`binLinks`](#binLinks)
17
18### Example
19
20```javascript
21// todo
22```
23
24### Features
25
26* Links bin files listed under the `bin` property of pkg to the node_modules/.bin
27directory of the installing environment.
28* Links man files listed under the `man` property of pkg to the share/man directory
29of the provided optional directory prefix.
30
31### Contributing
32
33The npm team enthusiastically welcomes contributions and project participation!
34There's a bunch of things you can do if you want to contribute! The [Contributor
35Guide](CONTRIBUTING.md) has all the information you need for everything from
36reporting bugs to contributing entire new features. Please don't hesitate to
37jump in if you'd like to, or even ask us questions if something isn't clear.
38
39### API
40
41#### <a name="binLinks"></a> `> binLinks(pkg, folder, global, opts, cb)`
42
43##### Example
44
45```javascript
46binLinks(pkg, folder, global, opts, cb)
47```