Add note about the user needing to create the actual directories

Fixes #10
rivy · Apr 28, 2019 · 294db55 · 294db55
1 parent d771ce6
commit 294db55
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -42,6 +42,8 @@ declare const envPaths: {
 	/**
 	Get paths for storing things like data, config, cache, etc.
 
+	Note: It only generates the path strings. It doesn't create the directories for you. You could use [`make-dir`](https://github.com/sindresorhus/make-dir) to create the directories.
+
 	@param name - Name of your project. Used to generate the paths.
 	@returns The paths to use for your project on current OS.
 

diff --git a/readme.md b/readme.md
@@ -31,6 +31,8 @@ paths.config
 
 ### paths = envPaths(name, [options])
 
+Note: It only generates the path strings. It doesn't create the directories for you. You could use [`make-dir`](https://github.com/sindresorhus/make-dir) to create the directories.
+
 #### name
 
 Type: `string`