summaryrefslogtreecommitdiff
path: root/node_modules/npm-conf/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/npm-conf/readme.md')
-rw-r--r--node_modules/npm-conf/readme.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/node_modules/npm-conf/readme.md b/node_modules/npm-conf/readme.md
new file mode 100644
index 0000000..d346d3e
--- /dev/null
+++ b/node_modules/npm-conf/readme.md
@@ -0,0 +1,47 @@
+# npm-conf [![Build Status](https://travis-ci.org/kevva/npm-conf.svg?branch=master)](https://travis-ci.org/kevva/npm-conf)
+
+> Get the npm config
+
+
+## Install
+
+```
+$ npm install npm-conf
+```
+
+
+## Usage
+
+```js
+const npmConf = require('npm-conf');
+
+const conf = npmConf();
+
+conf.get('prefix')
+//=> //=> /Users/unicorn/.npm-packages
+
+conf.get('registry')
+//=> https://registry.npmjs.org/
+```
+
+To get a list of all available `npm` config options:
+
+```bash
+$ npm config list --long
+```
+
+
+## API
+
+### npmConf()
+
+Returns the `npm` config.
+
+### npmConf.defaults
+
+Returns the default `npm` config.
+
+
+## License
+
+MIT © [Kevin Mårtensson](https://github.com/kevva)