From c5c2a57210e6b4e7f4ee012a28e861fd674cef87 Mon Sep 17 00:00:00 2001
From: Michael Paulson <mpaulson@netflix.com>
Date: Fri, 6 Nov 2020 07:28:18 -0800
Subject: [PATCH] feat(README)

---
 README.md | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 75 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9b0b1f7..6930aba 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,75 @@
-# harpoon
\ No newline at end of file
+# harpoon
+Harpoon is a terminal navigator for Neovim (currently, but I want vim to work
+as well).  Harpoon itself does not provide much for functionality other than
+goto a terminal, set a terminal, and sending commands.  Where it shines is in
+local configs.
+
+## Installation
+Simply install via your favorite plugin manager.
+
+```
+Plug 'ThePrimeagen/harpoon'
+```
+
+## Harpooning
+
+### The Basics
+Harpoon provides up to 4 slots for terminals.  Now you don't want to overload
+terminals with everything.  I just tend to think about this as project specific
+tasks.  Such as, `yarn lint`, `yarn test`, or some command based off of current
+file.
+
+Personally I only use 1 terminal.  I have no use for multiple terminals, but it
+does provide the hooks for that.
+
+### Navigation
+To start navigating with Harpoon you simply `:call GotoBuffer(<bufnu>)`.  This
+will create / navigate to the terminal in current buffer.
+
+`bufnu`: can be a number from 0 - 3.  As stated above, there are up to 4 slots.
+
+
+### Sending Commands
+Where Harpoon shines is in local configs.
+
+To setup a local config (per project) you must have a `.nvimrc` in the root of
+your project (where you open up vim) and you must have the following sets in your root vimrc.
+
+
+```
+set exrc
+set secure "optional, but it prevents harmful scripts from editing
+           "I don't have this option on
+```
+
+#### Local Configuration example
+For [VimDeathmatch](https://github.com/VimDeathmatch/server) we have a local
+config for running commands.  Here is an example.
+
+```
+nnoremap <leader>ce :call SendTerminalCommand(0, "cd ~/personal/VimDeathmatch/server/server && npm run test" . expand("%") . "\n")<CR>
+```
+
+1.  I have `c` as the start into my local commands.
+2.  e = middle finger, home row on Dvorak.  Power finger.
+3.  Setup your own commands
+
+
+That means when I am in Deathmatch and I want to test my current file I press
+<leader>ce and it will open a terminal if there isn't one opened and execute
+the commands.  I could of made that command a lot better, I was just in a hurry
+:)  Forgive me.
+
+#### General Navigation examples
+Personally I have the following remaps in my root rc.
+
+```
+nmap <leader>tu :call GotoBuffer(0)<CR>
+nmap <leader>te :call GotoBuffer(1)<CR>
+nmap <leader>to :call GotoBuffer(2)<CR>
+nmap <leader>ta :call GotoBuffer(3)<CR>
+```
+
+Same concept as before.  `t` is my entrence into the terminal world and aoeu is
+my homerow.  All power positions.
+