Permalink
Browse files

add FAQ

1 parent 23e6d1e commit c4a7fa2cfcbc94f1b43640852441cb70d39f38c8 @sindresorhus committed Oct 31, 2015
Showing with 7 additions and 0 deletions.
  1. +7 −0 readme.md
View
@@ -22,6 +22,13 @@ console.log(userHome);
Returns `null` in the unlikely scenario that the home directory can't be found.
+## FAQ
+
+### Why not just use the `os-home` module?
+
+This module was made long before [`os-homedir`](https://github.com/sindresorhus/os-homedir). When Node.js decided to add a native method for getting the user's home directory, I made a polyfill matching its API and decided to depend on it here, so not to have duplicate code. The main reason this one is still around is that lots of modules depend on it and I see no reason to inconvenience dependents by deprecating this. This one also gets the home directory on startup and returns a string rather than exposing a method, so it's faster, and I prefer this API. [Modules are cheap in Node.js](https://github.com/sindresorhus/ama/issues/10#issuecomment-117766328), so doesn't matter. Use whichever you prefer. I'm going to continue using this one.
+
+
## Related
- [user-home-cli](https://github.com/sindresorhus/user-home-cli) - CLI for this module

0 comments on commit c4a7fa2

Please sign in to comment.