diff options
Diffstat (limited to 'node_modules/homedir-polyfill/README.md')
| -rw-r--r-- | node_modules/homedir-polyfill/README.md | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/node_modules/homedir-polyfill/README.md b/node_modules/homedir-polyfill/README.md new file mode 100644 index 000000000..39b4b3873 --- /dev/null +++ b/node_modules/homedir-polyfill/README.md @@ -0,0 +1,75 @@ +# homedir-polyfill [](https://www.npmjs.com/package/homedir-polyfill) [](https://npmjs.org/package/homedir-polyfill) [](https://travis-ci.org/doowb/homedir-polyfill) [](https://ci.appveyor.com/project/doowb/homedir-polyfill) + +> Node.js os.homedir polyfill for older versions of node.js. + +## Install + +Install with [npm](https://www.npmjs.com/): + +```sh +$ npm install --save homedir-polyfill +``` + +## Usage + +```js +var homedir = require('homedir-polyfill'); +console.log(homedir()); +//=> /Users/doowb +``` + +## Reasoning + +This library is a polyfill for the [node.js os.homedir](https://nodejs.org/api/os.html#os_os_homedir) method found in modern versions of node.js. + +This implementation tries to follow the implementation found in `libuv` by finding the current user using the `process.geteuid()` method and the `/etc/passwd` file. This should usually work in a linux environment, but will also fallback to looking at user specific environment variables to build the user's home directory if neccessary. + +Since `/etc/passwd` is not available on windows platforms, this implementation will use environment variables to find the home directory. + +In modern versions of node.js, [os.homedir](https://nodejs.org/api/os.html#os_os_homedir) is used. + +## About + +### Related projects + +[parse-passwd](https://www.npmjs.com/package/parse-passwd): Parse a passwd file into a list of users. | [homepage](https://github.com/doowb/parse-passwd "Parse a passwd file into a list of users.") + +### Contributing + +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). + +Please read the [contributing guide](contributing.md) for avice on opening issues, pull requests, and coding standards. + +### Building docs + +_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_ + +To generate the readme and API documentation with [verb](https://github.com/verbose/verb): + +```sh +$ npm install -g verb verb-generate-readme && verb +``` + +### Running tests + +Install dev dependencies: + +```sh +$ npm install -d && npm test +``` + +### Author + +**Brian Woodward** + +* [github/doowb](https://github.com/doowb) +* [twitter/doowb](http://twitter.com/doowb) + +### License + +Copyright © 2016, [Brian Woodward](https://github.com/doowb). +Released under the [MIT license](LICENSE). + +*** + +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on October 19, 2016._
\ No newline at end of file |