summaryrefslogtreecommitdiff
path: root/tools/eslint/node_modules/user-home/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/eslint/node_modules/user-home/readme.md')
-rw-r--r--tools/eslint/node_modules/user-home/readme.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/tools/eslint/node_modules/user-home/readme.md b/tools/eslint/node_modules/user-home/readme.md
new file mode 100644
index 0000000000..5307a07ef5
--- /dev/null
+++ b/tools/eslint/node_modules/user-home/readme.md
@@ -0,0 +1,42 @@
+# user-home [![Build Status](https://travis-ci.org/sindresorhus/user-home.svg?branch=master)](https://travis-ci.org/sindresorhus/user-home)
+
+> Get the path to the user home directory
+
+
+## Install
+
+```sh
+$ npm install --save user-home
+```
+
+
+## Usage
+
+```js
+var userHome = require('user-home');
+
+console.log(userHome);
+//=> /Users/sindresorhus
+```
+
+Returns `null` in the unlikely scenario that the home directory can't be found.
+
+
+## CLI
+
+```sh
+$ npm install --global user-home
+```
+
+```sh
+$ user-home --help
+
+Example
+ $ user-home
+ /Users/sindresorhus
+```
+
+
+## License
+
+MIT © [Sindre Sorhus](http://sindresorhus.com)