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

   1 # global-modules [![NPM version](https://img.shields.io/npm/v/global-modules.svg?style=flat)](https://www.npmjs.com/package/global-modules) [![NPM downloads](https://img.shields.io/npm/dm/global-modules.svg?style=flat)](https://npmjs.org/package/global-modules) [![Build Status](https://img.shields.io/travis/jonschlinkert/global-modules.svg?style=flat)](https://travis-ci.org/jonschlinkert/global-modules)
   2
   3 The directory used by npm for globally installed npm modules.
   4
   5 ## Install
   6
   7 Install with [npm](https://www.npmjs.com/):
   8
   9 ```sh
  10 $ npm install --save global-modules
  11 ```
  12
  13 ## Usage
  14
  15 ```js
  16 var dir = require('global-modules');
  17 //=> '/usr/local/lib/node_modules' (depends on OS)
  18 ```
  19
  20 ## About
  21
  22 ### Related projects
  23
  24 * [contains-path](https://www.npmjs.com/package/contains-path): Return true if a file path contains the given path. | [homepage](https://github.com/jonschlinkert/contains-path "Return true if a file path contains the given path.")
  25 * [git-config-path](https://www.npmjs.com/package/git-config-path): Resolve the path to the user's global .gitconfig. | [homepage](https://github.com/jonschlinkert/git-config-path "Resolve the path to the user's global .gitconfig.")
  26 * [global-prefix](https://www.npmjs.com/package/global-prefix): Get the npm global path prefix. | [homepage](https://github.com/jonschlinkert/global-prefix "Get the npm global path prefix.")
  27 * [npm-paths](https://www.npmjs.com/package/npm-paths): Returns an array of unique "npm" directories based on the user's platform and environment. | [homepage](https://github.com/jonschlinkert/npm-paths "Returns an array of unique "npm" directories based on the user's platform and environment.")
  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 ### Building docs
  34
  35 _(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).)_
  36
  37 To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
  38
  39 ```sh
  40 $ npm install -g verb verb-generate-readme && verb
  41 ```
  42
  43 ### Running tests
  44
  45 Install dev dependencies:
  46
  47 ```sh
  48 $ npm install -d && npm test
  49 ```
  50
  51 ### Author
  52
  53 **Jon Schlinkert**
  54
  55 * [github/jonschlinkert](https://github.com/jonschlinkert)
  56 * [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
  57
  58 ### License
  59
  60 Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
  61 Released under the [MIT license](https://github.com/jonschlinkert/global-modules/blob/master/LICENSE).
  62
  63 ***
  64
  65 _This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on July 26, 2016._