From cc2981b9ef63adc4bf96e86226b71d13f80ce2d4 Mon Sep 17 00:00:00 2001
From: Brian Donovan <donovan@squareup.com>
Date: Tue, 30 Jul 2013 14:42:39 -0700
Subject: [PATCH] Add some usage info to the README.

---
 README.md | 45 ++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 38 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index b4031f3..bde8c58 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,47 @@
-Maximum Awesome
-===============
+# Maximum Awesome
 
 Config files for vim and tmux, lovingly tended by a small subculture of
-peace-loving hippies.
+peace-loving hippies. Built for Mac OS X.
 
-Install
--------
+## What's in it?
+
+* [MacVim](https://code.google.com/p/macvim/) (independent or for use in a terminal)
+* [iTerm 2](http://www.iterm2.com/)
+* [tmux](http://tmux.sourceforge.net/)
+* Awesome syntax highlighting with the [Solarized color scheme](http://ethanschoonover.com/solarized)
+
+### vim
+
+* `,d` brings up [NERDTree](https://github.com/scrooloose/nerdtree), a sidebar buffer for navigating and manipulating files
+* `,t` brings up [Command-T](https://github.com/wincent/Command-T), a project file filter for easily opening specific files
+* `,b` restricts Command-T to open buffers
+* `,a` starts project search with [ack.vim](https://github.com/mileszs/ack.vim) using [ag](https://github.com/ggreer/the_silver_searcher) (like ack)
+* `ds`/`cs` delete/change surrounding characters (e.g. `"Hey!"` + `ds"` = `Hey!`, `"Hey!"` + `cs"'` = `'Hey!'`) with [vim-surround](https://github.com/tpope/vim-surround)
+* `\\\` toggles current line comment
+* `\\` toggles visual selection comment lines
+* `vii`/`vai` visually select *in* or *around* the cursor's indent
+* `,[space]` strips trailing whitespace
+* `^]` jump to definition using ctags
+* `,l` begins aligning lines on a string, usually used as `,l=` to align assignments
+* `^hjkl` move between windows, shorthand for `^w hjkl`
+
+### tmux
+
+* `^a` is the prefix
+* mouse scroll initiates tmux scroll
+* `prefix v` makes a vertical split
+* `prefix s` makes a horizontal split
+
+## Install
 
     rake
 
-Troubleshoot
-------------
+## Troubleshoot
 
 If you have trouble compiling the Command-T C extension, check mkmf.log in the
 current directory; you may need to use `xcode-select(1)`.
+
+## Acknowledgements
+
+Thanks to the vimsters at Square who put this together. Thanks to Tim Pope for
+his awesome vim plugins.
-- 
GitLab