docs: add note about zsh completion prerequisite (#187)

sezna · Sep 28, 2018 · 13088e7 · 13088e7
1 parent 4a49142
commit 13088e7
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -252,6 +252,8 @@ Normally `<your-bash-profile-file>` will be `~/.bash_profile`, `~/.bashrc`, or `
 Note: you should probably only do this if you have the package installed globally. In that case you should probably also
 normally use the `nps` alias rather than `nps` because it's easier to type.
 
+Note: for zsh support, you must [enable zsh's bash completion script compatibility mode](https://stackoverflow.com/a/8492043/5932012).
+
 #### CLI options
 
 ##### -h, --help