From ff1101d790cf67d0ab8cabfbf3f5ee653c120cdc Mon Sep 17 00:00:00 2001
From: Joshua Potter <jrpotter2112@gmail.com>
Date: Mon, 7 Nov 2016 17:53:43 -0800
Subject: [PATCH] further readme and doc

---
 README.md         | 49 ++++++++++++++++++++++++++++++++++++++++-------
 doc/highlight.txt |  9 +++++++++
 doc/tags          |  1 +
 3 files changed, 52 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 733a6e9..d173f1f 100644
--- a/README.md
+++ b/README.md
@@ -8,16 +8,51 @@ necessary to search for different keywords without overriding previous searches;
 that is, I wanted to be able to continue adding more words to a search without
 having to keep track of which words I've already searched for.
 
-Functionality includes:
+["x]&                               Highlights the <cword> under the cursor
+                                    into register x.
 
-* ```["x]&```: Add the <cword> under the cursor into highlight registry ```x```.
-* ```["x]d&```: Remove <cword> under the cursor from highlight registry ```x```.
-* ```["x]c&```: Clear all words from highlight registry ```x```.
+["x]y&                              Sets the search register to the contents of
+                                    register x.
 
-Additionally, overrides the following:
+["x]d&                              Removes the <cword> from register x.
 
-* ```["x]*```: Searches for the next <cword> and appends word into registry ```x```.
-* ```["x]#```: Searches for the previous <cword> and appends word into registry ```x```.
+["x]c&                              Emptys register x. No patterns previously
+                                    belonging inside this register will be
+                                    highlighted.
+
+["x]*                               Highlights the <cword> under the cursor
+                                    into register x. Moves to the next
+                                    occurrence of the <cword>.
+
+["x]#                               Highlights the <cword> under the cursor
+                                    into register x. Moves to the previous
+                                    occurrence of the <cword>.
+
+["x]g&                              Highlights the <cword> under the cursor, but
+                                    without forcing any highlighted occurrences
+                                    to be a word. That is, if the selected
+                                    <cword> is a substring of any text in the
+                                    current buffer, the substring will also be
+                                    highlighted.
+
+["x]g*                              Works like ["x]g& but also moves to the next
+                                    occurrence of the pattern.
+
+["x]g#                              Works like ["x]g& but also moves to the
+                                    previous occurrence of the pattern.
+
+v_["x]&                             Note the v indicates visual mode. Works like
+                                    g&, but with the visually selected region.
+
+v_["x]*                             Note the v indicates visual mode. Works like
+                                    g*, but with the visually selected region.
+
+v_["x]#                             Note the v indicates visual mode. Works like
+                                    g#, but with the visually selected region.
+
+v_["x]d&                            Note the v indicates visual mode. Removes
+                                    the visually selected region from register
+                                    x.
 
 Variables
 ---------
diff --git a/doc/highlight.txt b/doc/highlight.txt
index 24b33a3..b1f6d24 100644
--- a/doc/highlight.txt
+++ b/doc/highlight.txt
@@ -4,6 +4,7 @@
 CONTENTS                                                 *highlight-contents*
 
 1. Usage .................................................. |highlight-usage|
+2. Variables .......................................... |highlight-variables|
 
 ============================================================================
 Section 1: Usage                                            *highlight-usage*
@@ -54,4 +55,12 @@ v_["x]d&                            Note the v indicates visual mode. Removes
                                     the visually selected region from register
                                     x.
 
+============================================================================
+Section 2: Variables                                    *highlight-variables*
+
+g:highlight_register_default_color
+
+                    Default color used when initializing an unused register.
+
+
 vim:tw=78:ts=8:ft=help:norl:
diff --git a/doc/tags b/doc/tags
index bbe3409..dde89a0 100644
--- a/doc/tags
+++ b/doc/tags
@@ -1,3 +1,4 @@
 highlight-contents	highlight.txt	/*highlight-contents*
 highlight-usage	highlight.txt	/*highlight-usage*
+highlight-variables	highlight.txt	/*highlight-variables*
 highlight.txt	highlight.txt	/*highlight.txt*