Documentation updates

README.rst

@@ -7,8 +7,6 @@ Vimteractive
 :Homepage: https://github.com/williamjameshandley/vimteractive
 :Documentation: ``:help vimteractive``
 
-Send commands from text files to interactive programs via vim.
-
 Vimteractive was inspired by the workflow of the
 `vim-ipython <https://github.com/ivanov/vim-ipython>`__ plugin.
 
@@ -48,7 +46,7 @@ disable this by putting
 
    stty -ixon
 
-into your ``.bashrc``
+into your ``.bashrc`` (or equivalent shell profile file).
 
 Installation should be relatively painless via the usual routes such as
 `Vundle <https://github.com/VundleVim/Vundle.vim>`__,
@@ -137,31 +135,6 @@ Supported terminals
 -  ``:Iclojure`` Activate a clojure terminal
 -  ``:Iterm`` Activate default terminal for this filetype
 
-You can easily add your interpreter to Vimteractive, using the following code in your ``.vimrc``:
-
-.. code:: vim
-
-    " Mapping from Vimterpreter command to shell command
-    " This would give you :Iasyncpython command
-    let g:vimteractive_commands = {
-        \ 'asyncpython': 'python3 -m asyncio'
-        \ }
-
-    " If you see strange symbols like ^[[200~ when sending lines
-    " to your new interpreter, disable bracketed paste for it
-    " It's not needed for python3 -m asyncio, code below is only
-    " an example.
-    let g:vimteractive_bracketed_paste = {
-        \ 'asyncpython': 0
-        \ }
-
-    " If you want to set interpreter as default (used by :Iterm),
-    " map filetype to it. If not set, :Iterm will use interpreter
-    " named same with filetype.
-    let g:vimteractive_default_shells = {
-        \ 'python': 'asyncpython'
-        \ }
-
 Sending commands
 ~~~~~~~~~~~~~~~~
 
@@ -187,6 +160,33 @@ that arise on your system, feel free to `leave an issue <https://github.com/will
 request <https://gist.github.com/Chaser324/ce0505fbed06b947d962>`__ with
 your proposed changes
 
+You can easily add your interpreter to Vimteractive, using the following code
+in your ``.vimrc``:
+
+.. code:: vim
+
+    " Mapping from Vimterpreter command to shell command
+    " This would give you :Iasyncpython command
+    let g:vimteractive_commands = {
+        \ 'asyncpython': 'python3 -m asyncio'
+        \ }
+
+    " If you see strange symbols like ^[[200~ when sending lines
+    " to your new interpreter, disable bracketed paste for it
+    " It's not needed for python3 -m asyncio, code below is only
+    " an example.
+    let g:vimteractive_bracketed_paste = {
+        \ 'asyncpython': 0
+        \ }
+
+    " If you want to set interpreter as default (used by :Iterm),
+    " map filetype to it. If not set, :Iterm will use interpreter
+    " named same with filetype.
+    let g:vimteractive_default_shells = {
+        \ 'python': 'asyncpython'
+        \ }
+
+
 Similar projects
 ----------------
 

doc/vimteractive.txt

@@ -20,7 +20,13 @@ Vimteractive was inspired by the workflow of the vim-ipython plugin:
     https://github.com/ivanov/vim-ipython
 
 This plugin is designed to extend a subset of the functionality of vimteractive
-to other interpreters (including ipython). 
+to other interpreters (including ipython). This plugin is designed to extend a
+subset of the functionality of vim-ipython to other interpreters (including
+ipython). It is based around the unix philosophy of "do one thing and do it
+well".  It aims to provide a robust and simple link between text files and
+interactive interpreters. Vimteractive will never aim to do things like
+autocompletion, leaving that to other, more developed tools such as
+YouCompleteMe.
 
 The activating commands are 
 - ipython |:Iipython| 
@@ -48,7 +54,7 @@ a terminal command to freeze the output. You can disable this by putting
 
 stty -ixon
 
-into your .bashrc
+into your .bashrc (or equivalent shell profile file)
 
 ------------------------------------------------------------------------------
 Example usage: