mirror of
https://github.com/nodejs/node.git
synced 2025-05-17 22:02:33 +00:00
d3b1c971bc
PR-URL: https://github.com/nodejs/node/pull/17777 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
47 lines
1.7 KiB
Markdown
47 lines
1.7 KiB
Markdown
# bin-links [](https://npm.im/bin-links) [](https://npm.im/bin-links) [](https://travis-ci.org/npm/bin-links) [](https://ci.appveyor.com/project/npm/bin-links) [](https://coveralls.io/github/npm/bin-links?branch=latest)
|
|
|
|
[`bin-links`](https://github.com/npm/bin-links) is a standalone library that links
|
|
binaries and man pages for Javascript packages
|
|
|
|
## Install
|
|
|
|
`$ npm install bin-links`
|
|
|
|
## Table of Contents
|
|
|
|
* [Example](#example)
|
|
* [Features](#features)
|
|
* [Contributing](#contributing)
|
|
* [API](#api)
|
|
* [`binLinks`](#binLinks)
|
|
|
|
### Example
|
|
|
|
```javascript
|
|
// todo
|
|
```
|
|
|
|
### Features
|
|
|
|
* Links bin files listed under the `bin` property of pkg to the node_modules/.bin
|
|
directory of the installing environment.
|
|
* Links man files listed under the `man` property of pkg to the share/man directory
|
|
of the provided optional directory prefix.
|
|
|
|
### Contributing
|
|
|
|
The npm team enthusiastically welcomes contributions and project participation!
|
|
There's a bunch of things you can do if you want to contribute! The [Contributor
|
|
Guide](CONTRIBUTING.md) has all the information you need for everything from
|
|
reporting bugs to contributing entire new features. Please don't hesitate to
|
|
jump in if you'd like to, or even ask us questions if something isn't clear.
|
|
|
|
### API
|
|
|
|
#### <a name="binLinks"></a> `> binLinks(pkg, folder, global, opts, cb)`
|
|
|
|
##### Example
|
|
|
|
```javascript
|
|
binLinks(pkg, folder, global, opts, cb)
|
|
``` |