diff --git a/README.md b/README.md index 17f2606..a14525a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ # zsh/fzf History Search +![zsh-fzf-history-search plugin screenshot](https://josh.sh/5UPr.png) + +A simple zsh plugin to replace `Ctrl-r` with an fzf-driven, searchable list of history. + +**Pull requests always appreciated!** + +## Requirements +* [fzf](https://github.com/junegunn/fzf) ## Installation with zinit @@ -9,3 +17,7 @@ Add this to `~/.zshrc`: zinit ice lucid wait'0' zinit light joshskidmore/zsh-fzf-history-search ``` + +## TODO +* use fzf's keybindings for additional functionality (remove specific history item, clear history, etc) while keeping plugin's simplicity in mind ([issue](https://github.com/joshskidmore/zsh-fzf-history-search/issues/10)) +* better documentation ([issue](https://github.com/joshskidmore/zsh-fzf-history-search/issues/11))