aboutsummaryrefslogtreecommitdiff
path: root/node_modules/registry-url/readme.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-05-28 00:38:50 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-05-28 00:40:43 +0200
commit7fff4499fd915bcea3fa93b1aa8b35f4fe7a6027 (patch)
tree6de9a1aebd150a23b7f8c273ec657a5d0a18fe3e /node_modules/registry-url/readme.md
parent963b7a41feb29cc4be090a2446bdfe0c1f1bcd81 (diff)
downloadwallet-core-7fff4499fd915bcea3fa93b1aa8b35f4fe7a6027.tar.xz
add linting (and some initial fixes)
Diffstat (limited to 'node_modules/registry-url/readme.md')
-rw-r--r--node_modules/registry-url/readme.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/node_modules/registry-url/readme.md b/node_modules/registry-url/readme.md
new file mode 100644
index 000000000..6fc55bc5f
--- /dev/null
+++ b/node_modules/registry-url/readme.md
@@ -0,0 +1,50 @@
+# registry-url [![Build Status](https://travis-ci.org/sindresorhus/registry-url.svg?branch=master)](https://travis-ci.org/sindresorhus/registry-url)
+
+> Get the set npm registry URL
+
+It's usually `https://registry.npmjs.org/`, but [configurable](https://www.npmjs.org/doc/misc/npm-config.html#registry).
+
+Use this if you do anything with the npm registry as users will expect it to use their configured registry.
+
+
+## Install
+
+```
+$ npm install --save registry-url
+```
+
+
+## Usage
+
+```ini
+# .npmrc
+registry = 'https://custom-registry.com/'
+```
+
+```js
+const registryUrl = require('registry-url');
+
+console.log(registryUrl());
+//=> 'https://custom-registry.com/'
+```
+
+It can also retrieve the registry URL associated with an [npm scope](https://docs.npmjs.com/misc/scope).
+
+```ini
+# .npmrc
+@myco:registry = 'https://custom-registry.com/'
+```
+
+```js
+const registryUrl = require('registry-url');
+
+console.log(registryUrl('@myco'));
+//=> 'https://custom-registry.com/'
+```
+
+If the provided scope is not in the user's `.npmrc` file, then `registry-url` will check for the existence of `registry`, or if that's not set, fallback to the default npm registry.
+
+
+## License
+
+MIT © [Sindre Sorhus](http://sindresorhus.com)