Update README and docs

Author: benmills

README.mkd

@@ -1,6 +1,8 @@
 # vimux
 
-Easily interact with tmux from vim. This project is still in development, so some features are still missing.
+Easily interact with tmux from vim.
+
+![vimux](https://www.braintreepayments.com/assets-faccd47687/assets/images/blog/vimux3.png) 
 
 What inspired me to write vimux was [tslime.vim](https://github.com/kikijump/tslime.vim), a plugin that lets you send input to tmux. While tslime.vim works well, I felt it wasn't optimized for my primary use case which was having a smaller tmux pane that I would use to run tests or play with a REPL. 
 
@@ -21,143 +23,4 @@ Otherwise download the latest [tarball](https://github.com/benmills/vimux/tarbal
 
 ## Usage
 
-### RunVimTmuxCommand
-Run a system command in a small horizontal split bellow the current pane vim is in. You can optionally pass a second argument to stop vimux from automatically sending a return after the command.
-
-```viml
-" Run the current file with rspec
-map <Leader>rb :call RunVimTmuxCommand("clear; rspec " . bufname("%"))<CR>
-
-" Run command without sending sending a return
-map <Leader>rq :call RunVimTmuxCommand("clear; rspec " . bufname("%"), 0)<CR>
-```
-
-### PromptVimTmuxCommand
-Prompt for a command and run it in a small horizontal split bellow the current pane.
-
-```viml
-" Prompt for a command to run
-map <Leader>rp :PromptVimTmuxCommand<CR>
-```
-
-### RunLastVimTmuxCommand
-Run the last command executed by `RunVimTmuxCommand`
-
-```viml
-" Run last command executed by RunVimTmuxCommand
-map <Leader>rl :RunLastVimTmuxCommand<CR>
-```
-
-### InspectVimTmuxRunner
-Move into the tmux runner pane created by `RunVimTmuxCommand` and enter copy mode (scroll mode).
-
-```viml
-" Inspect runner pane
-map <Leader>ri :InspectVimTmuxRunner<CR>
-```
-
-### CloseVimTmuxRunner
-Close the tmux runner created by `RunVimTmuxCommand`
-
-```viml
-" Close vim tmux runner opened by RunVimTmuxCommand
-map <Leader>rq :CloseVimTmuxRunner<CR>
-```
-
-### CloseVimTmuxPanes
-Close all other tmux panes in the current window.
-
-```viml
-" Close all other tmux panes in current window
-map <Leader>rx :CloseVimTmuxPanes<CR>
-```
-
-### InterruptVimTmuxRunner
-Interrupt any command that is running inside the runner pane.
-
-```viml
-" Interrupt any command running in the runner pane
-map <Leader>rs :InterruptVimTmuxRunner<CR>
-```
-
-### Full Keybind Example
-
-```viml
-" Run the current file with rspec
-map <Leader>rb :call RunVimTmuxCommand("clear; rspec " . bufname("%"))<CR>
-
-" Prompt for a command to run
-map <Leader>rp :PromptVimTmuxCommand<CR>
-
-" Run last command executed by RunVimTmuxCommand
-map <Leader>rl :RunLastVimTmuxCommand<CR>
-
-" Inspect runner pane
-map <Leader>ri :InspectVimTmuxRunner<CR>
-
-" Close all other tmux panes in current window
-map <Leader>rx :CloseVimTmuxPanes<CR>
-
-" Close vim tmux runner opened by RunVimTmuxCommand
-map <Leader>rq :CloseVimTmuxRunner<CR>
-
-" Interrupt any command running in the runner pane
-map <Leader>rs :InterruptVimTmuxRunner<CR>
-```
-
-### tslime replacement
-
-Here is how to use vimux to send code to a REPL. This is similar to tslime. First, add some helpful mappings.
-
-```viml
-
-" Prompt for a command to run
-map <LocalLeader>vp :PromptVimTmuxCommand<CR>
-
-" If text is selected, save it in the v buffer and send that buffer it to tmux
-vmap <LocalLeader>vs "vy :call RunVimTmuxCommand(@v . "\n", 0)<CR>
-
-" Select current paragraph and send it to tmux
-nmap <LocalLeader>vs vip<LocalLeader>vs<CR>
-```
-
-Now, open a clojure file. Let's say your leader is backslash (\). Type \vp, and then type lein repl at the prompt. This opens a tmux split running a REPL. Then, select text or put the cursor on a function and type \vs. This will send it to the REPL and evaluate it. The reason we pass `0` to `RunVimTmuxCommand` is to stop the normal return that is sent to the runner pane and use our own new line so the clojure REPL will evaluate the selected text without adding an extra return. Thanks to @trptcolin for discovering this issue.
-
-## Options
-
-### VimuxHeight
-Set the percent height of the runner pane opened by `RunVimTmuxCommand`.
-**Default: `"20"`**
-
-```viml
-let VimuxHeight = "50"
-```
-
-### VimuxOrientation
-Set the default position of the runner pane.
-
-**Acceptable Values:**
-`"v"` Vertical
-`"h"` Horizontal
-
-**Default: `"v"`**
-
-```viml
-let VimuxOrientation = "h"
-```
-
-### VimuxUseNearestPane
-Use nearest pane (not used by vim) if found instead of running split-window.  Useful if you always have two panes opened and you want Vimux to use the existing one.
-
-```viml
-let VimuxUseNearestPane = 1
-```
-
-### VimuxResetSequence
-The keys sent to the runner pane before running a command. By default it sends `q` to make sure the pane is not in scroll-mode and `C-u` to clear the line.
-
-**Default: `"q C-u"`
-
-```viml
-let VimuxResetSequence = ""
-```
+The full documentation is available [online](https://raw.github.com/benmills/vimux/master/doc/vimux.txt) and accessible inside vim `:help vimux`

doc/vimux.txt

@@ -25,8 +25,6 @@ ABOUT (1)                                                           *VimuxAbout*
 
 Vimux -- Easily interact with tmux from vim.
 
-This project is still in development, so some features are still missing.
-
 What inspired me to write vimux was tslime.vim [1], a plugin that lets you
 send input to tmux. While tslime.vim works well, I felt it wasn't optimized
 for my primary use case which was having a smaller tmux pane that I would use
@@ -40,7 +38,7 @@ without losing focus of vim. Once that pane exists whenever you call
 using vimux myself I wanted to rerun commands over and over. An example of
 this was running the current file through rspec. Rather than typing that over
 and over I wrote `RunLastVimTmuxCommand` that will execute the last command
-you called with `RunVimTmuxCommand`. 
+you called with `RunVimTmuxCommand`.
 
 Other auxiliary functions and the ones I talked about above can be found
 bellow with a full description and example key binds for your vimrc.