aboutsummaryrefslogtreecommitdiff
path: root/node_modules/import-local/readme.md
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2018-11-08 00:38:48 +0800
committerruki <waruqi@gmail.com>2018-11-07 21:53:09 +0800
commit26105034da4fcce7ac883c899d781f016559310d (patch)
treec459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/import-local/readme.md
parent2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff)
downloadxmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz
xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip
switch to vuepress
Diffstat (limited to 'node_modules/import-local/readme.md')
-rw-r--r--node_modules/import-local/readme.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/node_modules/import-local/readme.md b/node_modules/import-local/readme.md
new file mode 100644
index 00000000..03254e8a
--- /dev/null
+++ b/node_modules/import-local/readme.md
@@ -0,0 +1,30 @@
+# import-local [![Build Status](https://travis-ci.org/sindresorhus/import-local.svg?branch=master)](https://travis-ci.org/sindresorhus/import-local)
+
+> Let a globally installed package use a locally installed version of itself if available
+
+Useful for CLI tools that want to defer to the user's locally installed version when available, but still work if it's not installed locally. For example, [AVA](http://ava.li) and [XO](https://github.com/sindresorhus/xo) uses this method.
+
+
+## Install
+
+```
+$ npm install import-local
+```
+
+
+## Usage
+
+```js
+const importLocal = require('import-local');
+
+if (importLocal(__filename)) {
+ console.log('Using local version of this package');
+} else {
+ // Code for both global and local version here…
+}
+```
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)