From 58bac5dc298a5ef16efd664bc9ea951856f901ee Mon Sep 17 00:00:00 2001
From: Evgeniy Karagodin <ekaragodin@gmail.com>
Date: Mon, 24 Jun 2019 22:08:06 +0700
Subject: Add userHomeDir (denoland/deno_std#521)

Original: https://github.com/denoland/deno_std/commit/ff7fb5a5d696256b232f8435c53087d5b12848ab
---
 os/README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 os/README.md

(limited to 'os/README.md')

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();
+```
-- 
cgit v1.2.3