You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

86 lines
3.4 KiB

4 years ago
  1. # global-modules [![NPM version](https://img.shields.io/npm/v/global-modules.svg?style=flat)](https://www.npmjs.com/package/global-modules) [![NPM monthly downloads](https://img.shields.io/npm/dm/global-modules.svg?style=flat)](https://npmjs.org/package/global-modules) [![NPM total downloads](https://img.shields.io/npm/dt/global-modules.svg?style=flat)](https://npmjs.org/package/global-modules) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/global-modules.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/global-modules)
  2. > The directory used by npm for globally installed npm modules.
  3. Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
  4. ## Install
  5. Install with [npm](https://www.npmjs.com/):
  6. ```sh
  7. $ npm install --save global-modules
  8. ```
  9. ## Usage
  10. ```js
  11. const globalModules = require('global-modules');
  12. console.log(globalModules);
  13. //=> '/usr/local/lib/node_modules'
  14. ```
  15. _(Note that this path might be different based on platform, user-defined configuration settings, etc)_
  16. ## About
  17. <details>
  18. <summary><strong>Contributing</strong></summary>
  19. Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
  20. </details>
  21. <details>
  22. <summary><strong>Running Tests</strong></summary>
  23. Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
  24. ```sh
  25. $ npm install && npm test
  26. ```
  27. </details>
  28. <details>
  29. <summary><strong>Building docs</strong></summary>
  30. _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
  31. To generate the readme, run the following command:
  32. ```sh
  33. $ npm install -g verbose/verb#dev verb-generate-readme && verb
  34. ```
  35. </details>
  36. ### Related projects
  37. You might also be interested in these projects:
  38. * [git-config-path](https://www.npmjs.com/package/git-config-path): Resolve the path to the user's local or global .gitconfig. | [homepage](https://github.com/jonschlinkert/git-config-path "Resolve the path to the user's local or global .gitconfig.")
  39. * [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.")
  40. * [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.")
  41. ### Contributors
  42. | **Commits** | **Contributor** |
  43. | --- | --- |
  44. | 20 | [jonschlinkert](https://github.com/jonschlinkert) |
  45. | 1 | [Kikobeats](https://github.com/Kikobeats) |
  46. ### Author
  47. **Jon Schlinkert**
  48. * [GitHub Profile](https://github.com/jonschlinkert)
  49. * [Twitter Profile](https://twitter.com/jonschlinkert)
  50. * [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
  51. ### License
  52. Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
  53. Released under the [MIT License](LICENSE).
  54. ***
  55. _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on December 14, 2018._