From 0107d4e486302394fd32d5861ced20c09a8dacae Mon Sep 17 00:00:00 2001
From: Luke Childs <lukechilds123@gmail.com>
Date: Thu, 18 Aug 2016 17:49:50 +0100
Subject: [PATCH] Document `NVM_DIR` option

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index c1e0f73..0082da7 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,19 @@ Previous HEAD position was 56417f8... v0.31.3
 HEAD is now at 2176894... v0.31.0
 ```
 
+## Options
+
+### Custom Directory
+
+You can specify a custom directory to use with `nvm` by exporting the `NVM_DIR` environment variable. It must be set before `zsh-nvm` is loaded. For example, if you are using antigen, you would put the following in your `.zshrc`:
+
+```shell
+export NVM_DIR="$HOME/.custom-nvm-dir"
+antigen bundle lukechilds/zsh-nvm
+```
+
+Note: If `nvm` doesn't exist in this directory it'll be automatically installed when you start a session.
+
 ## Installation
 
 ### Using [Antigen](https://github.com/zsh-users/antigen)