From 4d9b74aebdcfe3c09590495fb2de3dfa315e3e52 Mon Sep 17 00:00:00 2001
From: Colin Hebert <hebert.colin@gmail.com>
Date: Wed, 4 Apr 2012 14:20:34 +0100
Subject: [PATCH] Add history-substring-search readme

---
 plugins/history-substring-search/README.md | 34 ++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 plugins/history-substring-search/README.md

diff --git a/plugins/history-substring-search/README.md b/plugins/history-substring-search/README.md
new file mode 100644
index 00000000..91a49183
--- /dev/null
+++ b/plugins/history-substring-search/README.md
@@ -0,0 +1,34 @@
+history-substring-search
+========================
+
+This is a clean-room implementation of the [Fish shell][1]'s history search
+feature, where you can type in any part of any previously entered command
+and press the `UP` and `DOWN` arrow keys to cycle through the matching commands.
+
+Settings
+--------
+
+### Case sensitivity
+
+To enable case-sensitive search, add this line to the configuration file:
+
+    zstyle ':omz:plugin:history-substring-search' case-sensitive 'yes'
+
+### Highlighting
+
+If colours are enabled, _history-substring-search_ will automatically highlight
+positive results.
+
+To enable highlighting for this plugin only:
+
+    zstyle -t ':omz:plugin:history-substring-search' color 'yes'
+
+Authors
+-------
+
+*The authors of this plugin should be contacted via the github bug tracker.*
+
+ - [Sorin Ionescu](/sorin-ionescu)
+ - [Suraj N. Kurapati](/sunaku)
+
+[1]: http://fishshell.com