www.aleph1.co.uk Git - yaffs-website/blob - node_modules/global-prefix/README.md

   1 # global-prefix [![NPM version](https://img.shields.io/npm/v/global-prefix.svg?style=flat)](https://www.npmjs.com/package/global-prefix) [![NPM downloads](https://img.shields.io/npm/dm/global-prefix.svg?style=flat)](https://npmjs.org/package/global-prefix) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/global-prefix.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/global-prefix) [![Windows Build Status](https://img.shields.io/appveyor/ci/jonschlinkert/global-prefix.svg?style=flat&label=AppVeyor)](https://ci.appveyor.com/project/jonschlinkert/global-prefix)
   2
   3 > Get the npm global path prefix.
   4
   5 ## Install
   6
   7 Install with [npm](https://www.npmjs.com/):
   8
   9 ```sh
  10 $ npm install --save global-prefix
  11 ```
  12
  13 This is based on the code used by npm internally to resolve the global prefix.
  14
  15 ## Usage
  16
  17 ```js
  18 var prefix = require('global-prefix');
  19 //=> '/usr/local'
  20 ```
  21
  22 ## About
  23
  24 ### Related projects
  25
  26 * [global-modules](https://www.npmjs.com/package/global-modules): The directory used by npm for globally installed npm modules. | [homepage](https://github.com/jonschlinkert/global-modules "The directory used by npm for globally installed npm modules.")
  27 * [global-paths](https://www.npmjs.com/package/global-paths): Returns an array of unique "global" directories based on the user's platform and environment. The… [more](https://github.com/jonschlinkert/global-paths) | [homepage](https://github.com/jonschlinkert/global-paths "Returns an array of unique "global" directories based on the user's platform and environment. The resulting paths can be used for doing lookups for generators or other globally installed npm packages. Node.js / JavaScript.")
  28
  29 ### Contributing
  30
  31 Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
  32
  33 ### Contributors
  34
  35 | **Commits** | **Contributor** |
  36 | --- | --- |
  37 | 16 | [jonschlinkert](https://github.com/jonschlinkert) |
  38 | 1 | [rmbaad](https://github.com/rmbaad) |
  39 | 1 | [jason-chang](https://github.com/jason-chang) |
  40 | 1 | [jorrit](https://github.com/jorrit) |
  41 | 1 | [mathiasvr](https://github.com/mathiasvr) |
  42 | 1 | [tunnckoCore](https://github.com/tunnckoCore) |
  43
  44 ### Building docs
  45
  46 _(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
  47
  48 To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
  49
  50 ```sh
  51 $ npm install -g verb verb-generate-readme && verb
  52 ```
  53
  54 ### Running tests
  55
  56 Install dev dependencies:
  57
  58 ```sh
  59 $ npm install -d && npm test
  60 ```
  61
  62 ### Author
  63
  64 **Jon Schlinkert**
  65
  66 * [github/jonschlinkert](https://github.com/jonschlinkert)
  67 * [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
  68
  69 ### License
  70
  71 Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
  72 Released under the [MIT license](LICENSE).
  73
  74 ***
  75
  76 _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on November 30, 2016._