initial commit

README.md

@@ -1,4 +1,33 @@
-vim-airline
-===========
+# vim-airline
 
 lean & mean statusline for vim
+
+# rationale
+
+there's already [powerline](https://github.com/Lokaltog/powerline), why yet another statusline?
+
+*  it's standard vimscript, no python needed
+*  it's small.  i want the entire plugin to be less than 200 lines as a rule
+*  gets you 90% of the way there: in addition to all the standard goodies, supports [fugitve](https://github.com/tpope/vim-fugitive) and [syntastic](https://github.com/scrooloose/syntastic)
+*  it's fast.  since it's so small, it only takes 0.6ms to load.  by requiring python, powerline needs 60ms on the same machine.
+
+# why's it called airline?
+
+i wrote this on an airplane, and since it's light as air it turned out to be a good name :-)
+
+# configuration
+
+there are a couple configuration values available:
+
+* `g:airline_left_sep`  the seperator used on the left side
+* `g:airline_right_sep`  the seperator used on the right side
+* `g:airline_enable_fugitive`  enable/disable fugitive integration
+* `g:airline_enable_syntastic`  enable/disable syntastic integration
+
+# contributions
+
+contributions and pull requests are welcome.  please make sure to keep it as light as possible.
+
+# license
+
+`:h license`