diff --git a/README.md b/README.md index 717a6c8..ea87633 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,13 @@ +
+ +
+ # get-installed-path [![npm version][npmv-img]][npmv-url] [![github release][github-release-img]][github-release-url] [![mit License][license-img]][license-url] [![NPM Downloads Weekly][downloads-weekly-img]][downloads-weekly-url] [![NPM Downloads Total][downloads-total-img]][downloads-total-url] > Get installation path where the given package is installed. Works for globally and locally installed packages + + You might also be interested in [detect-installed](https://github.com/tunnckocore/detect-installed#readme). ## Quality Assurance :100: @@ -37,14 +43,16 @@ _(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc]( ## Install -This project requires [Node.js][nodeversion-url] v6 and above. Use [npm](https://www.npmjs.com) to install it. +This project requires [**Node.js**][nodeversion-url] **v6** and above. Use [**yarn**](https://yarnpkg.com) **v1** / [**npm**](https://www.npmjs.com) **v5** or above to install it. ``` -$ npm install get-installed-path +$ yarn add get-installed-path ``` +**[back to top](#thetop)** + ## API -Review carefully the provided examples and the working [tests](./test.js). +Review carefully the provided examples and the working [tests](./test/index.js). ### [getInstalledPath](src/index.js#L71) @@ -141,6 +149,8 @@ console.log(gmPath) // => '~/code/get-installed-path/node_modules/global-modules' ``` +**[back to top](#thetop)** + ## Related - [always-done](https://www.npmjs.com/package/always-done): Handle completion and errors with elegance! Support for streams, callbacks, promises, child… [more](https://github.com/hybridables/always-done#readme) | [homepage](https://github.com/hybridables/always-done#readme "Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement for [async-done][] - pass 100% of its tests plus more") - [detect-installed](https://www.npmjs.com/package/detect-installed): Checks that given package is installed globally or locally. | [homepage](https://github.com/tunnckocore/detect-installed#readme "Checks that given package is installed globally or locally.") @@ -151,6 +161,8 @@ console.log(gmPath) - [minibase](https://www.npmjs.com/package/minibase): Minimalist alternative for Base. Build complex APIs with small units called plugins… [more](https://github.com/node-minibase/minibase#readme) | [homepage](https://github.com/node-minibase/minibase#readme "Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing [base][] plugins.") - [try-catch-core](https://www.npmjs.com/package/try-catch-core): Low-level package to handle completion and errors of sync or asynchronous functions… [more](https://github.com/hybridables/try-catch-core#readme) | [homepage](https://github.com/hybridables/try-catch-core#readme "Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and used in higher-level libs such as [always-done][] to handle completion of anything.") +**[back to top](#thetop)** + ## Contributing Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue][open-issue-url]. Please read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents for advices. @@ -165,8 +177,8 @@ Copyright © 2016-2017, [Charlike Mike Reagent](https://i.am.charlike.online). R *** -_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on October 06, 2017._ -Project scaffolded using [charlike-cli][]. +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on October 09, 2017._ +Project scaffolded and managed with [hela][]. [always-done]: https://github.com/hybridables/always-done [async-done]: https://github.com/gulpjs/async-done @@ -233,4 +245,5 @@ Project scaffolded using [charlike-cli][]. [nodeversion-url]: https://nodejs.org/en/download [nodeversion-img]: https://img.shields.io/node/v/get-installed-path.svg -[global-modules]: https://github.com/jonschlinkert/global-modules \ No newline at end of file +[global-modules]: https://github.com/jonschlinkert/global-modules +[hela]: https://github.com/tunnckoCore/hela \ No newline at end of file diff --git a/package.json b/package.json index fb613ec..09a1b7e 100644 --- a/package.json +++ b/package.json @@ -88,10 +88,12 @@ "base", "charlike-cli", "dezalgo", - "once" + "once", + "global-modules", + "hela" ] }, "release": { "analyzeCommits": "simple-commit-message" } -} +} \ No newline at end of file