Add userHomeDir (denoland/deno_std#521)

Original: https://github.com/denoland/deno_std/commit/ff7fb5a5d696256b232f8435c53087d5b12848ab

1 files changed, 16 insertions, 0 deletions

diff --git a/os/README.md b/os/README.md
new file mode 100644
index 000000000..0f2ea810b
--- /dev/null
+++ b/os/README.md
@@ -0,0 +1,16 @@
+# os
+
+Module provide platform-independent interface to operating system functionality.
+
+## Usage
+
+### userHomeDir
+
+Returns the current user's home directory. On Unix, including macOS, it returns the \$HOME environment variable. On Windows, it returns %USERPROFILE%.
+Needs permissions to access env (--allow-env).
+
+```ts
+import { userHomeDir } from "https://deno.land/std/os/mod.ts";
+
+userHomeDir();
+```