Move docs from github wiki to 'docs/' directory

Author: Bruno Sutic

CHANGELOG.md

@@ -3,6 +3,7 @@
 ### master
 - if installed use `gawk` instead of `awk` (@metcalfc)
 - add stored search for matching git SHAs (@jbnicolai)
+- move documentation from github wiki to `docs/` folder
 
 ### v2.1.0, Jan 01, 2015
 - combine send-keys calls to reduce flickering (@toupeira)

README.md

@@ -62,20 +62,6 @@ Copying a highlighted match will take you "out" of copycat mode. Paste with
 Copying highlighted matches can be enhanced with
 [tmux yank](https://github.com/tmux-plugins/tmux-yank).
 
-### Customization
-
-Most of the behavior of tmux-copycat can be customized via tmux options.<br/>
-Check the full options list on
-[the wiki page](https://github.com/tmux-plugins/tmux-copycat/wiki/Customizations).
-
-#### Defining new stored searches
-
-To speed up the workflow you can define new bindings in `.tmux.conf` for
-searches you use often.
-
-How to + useful searches
-[in this wiki page](https://github.com/tmux-plugins/tmux-copycat/wiki/Defining-new-stored-searches).
-
 ### Limitations
 
 - This plugin tries hard to consistently enable "marketed" features. It uses some
@@ -131,6 +117,13 @@ You should now be able to use the plugin.
 Optional (but recommended) install `gawk` via your package manager of choice
 for better UTF-8 character support.
 
+### Docs
+
+- Most of the behavior of tmux-copycat can be customized via tmux options.
+  [Check out the full options list](docs/customizations.md).
+- To speed up the workflow you can define new bindings in `.tmux.conf` for
+  searches you use often, more info [here](docs/defining_new_stored_searches.md)
+
 ### Other goodies
 
 `tmux-copycat` works great with:

docs/customizations.md

@@ -0,0 +1,25 @@
+# Customizations
+
+Most of the behavior of tmux-copycat can be customized via tmux options.<br/>
+To set a value, just put `set -g @option 'value'` in your `.tmux.conf` before
+loading the tmux-copycat plugin.
+
+Other options:
+
+- `@copycat_search` (default `/`) defines the key-binding used (after prefix) to
+  start an interactive search.
+- `@copycat_next` (default `n`) defines the key (without prefix) used to jump to
+  next search result.
+- `@copycat_prev` (default `N`) defines the key (without prefix) used to jump to
+  previous search result.
+
+Options for predefined searches:
+
+- `@copycat_git_special` (default `C-g`) git status search
+- `@copycat_file_search` (default `C-f`) file search
+- `@copycat_url_search` (default `C-u`) url search
+- `@copycat_digit_search` (default `C-d`) digit search
+- `@copycat_ip_search` (default `M-i`) IP address search
+
+Example: to remap default file search to use `C-t` put
+`set -g @copycat_file_search 'C-t'` in `.tmux.conf`.

docs/defining_new_stored_searches.md

@@ -0,0 +1,40 @@
+# Defining new stored searches
+
+To speed up the workflow you can define new bindings in `.tmux.conf` for
+searches you use often.
+
+After adding any of the below snippets, make sure to reload your tmux
+configuration:
+
+    # type this in the terminal
+    $ tmux source-file ~/.tmux.conf
+
+Dummy examples (just for testing):
+
+* `prefix + ctrl-t` example string search
+
+        set -g @copycat_search_C-t 'search me'
+
+* `prefix + alt-t` example regex search
+
+        set -g @copycat_search_M-t 'regex search[[:alnum:]]\*'
+
+### Useful searches
+
+* `prefix + ctrl-e` in the Rails log output searches for previous request start
+
+        set -g @copycat_search_C-e '^Processing[[:space:]]by[[:space:]][^[:space:]]*'
+
+* `prefix + D` searches for numbers at the *beginning* of line.<br/>
+  Useful with `$ pgrep -lf process` command to quickly select process PID.
+
+      set -g @copycat_search_D '^[[:digit:]]+'
+
+* `prefix + G` searches for git commit SHA1.<br/>
+  Works for both the short (5 chars) and full (40 chars) versions.
+
+      set -g @copycat_search_G '\b[0-9a-f]{5,40}\b'
+
+
+Have your own custom search? Please share it in
+[the discussion](https://github.com/tmux-plugins/tmux-copycat/issues/57).