diff --git a/modules/history-substring-search/README.md b/modules/history-substring-search/README.md index f8ab5b1..3622606 100644 --- a/modules/history-substring-search/README.md +++ b/modules/history-substring-search/README.md @@ -3,10 +3,15 @@ History-Substring-Search Allows for fish shell-like searching of history with UP and DOWN. -The options set explicitly by init.zsh are the default options, and are only set for consistancy. - ![example][fish_shell] +This module requires the [input](https://github.com/Eriner/zim/blob/master/modules/input/README.md) module. Without it, you may experience odd behavior. +Put 'input' in the first line and 'history-substring-search' on the second line of `zmodules` in your `.zimrc`. + +Additionally, if you use [syntax-highlighting](https://github.com/Eriner/zim/blob/master/modules/syntax-highlighting/README.md), place 'syntax-highlighting' before 'history-substring-search' on the second line of `zmodules` in your `.zimrc`. + +The options set explicitly by init.zsh are the default options, and are only set for consistancy. + Functionality is sourced from [history-substring-search](https://github.com/zsh-users/zsh-history-substring-search) Contributing