aboutsummaryrefslogtreecommitdiff
path: root/node_modules/is-installed-globally/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/is-installed-globally/readme.md')
-rw-r--r--node_modules/is-installed-globally/readme.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/node_modules/is-installed-globally/readme.md b/node_modules/is-installed-globally/readme.md
new file mode 100644
index 0000000..ef9e18a
--- /dev/null
+++ b/node_modules/is-installed-globally/readme.md
@@ -0,0 +1,31 @@
+# is-installed-globally
+
+> Check if your package was installed globally
+
+Can be useful if your CLI needs different behavior when installed globally and locally.
+
+## Install
+
+```
+$ npm install is-installed-globally
+```
+
+## Usage
+
+```js
+const isInstalledGlobally = require('is-installed-globally');
+
+// With `npm install your-package`
+console.log(isInstalledGlobally);
+//=> false
+
+// With `npm install --global your-package`
+console.log(isInstalledGlobally);
+//=> true
+```
+
+## Related
+
+- [import-global](https://github.com/sindresorhus/import-global) - Import a globally installed module
+- [resolve-global](https://github.com/sindresorhus/resolve-global) - Resolve the path of a globally installed module
+- [global-dirs](https://github.com/sindresorhus/global-dirs) - Get the directory of globally installed packages and binaries