readme

README.md

@@ -0,0 +1,36 @@
+# moonscript-vim
+
+Adds syntax highlighting and indent support for MoonScript in vim.
+
+## Install
+
+### Using [Vundle](https://github.com/gmarik/vundle)
+
+1. Add the following to your `.vimrc` where other bundle's are located:
+
+		Bundle 'leafo/moonscript-vim'
+
+2. Run from command line:
+
+		$ vim +BundleInstall
+
+### Using [pathogen](https://github.com/tpope/vim-pathogen)
+
+1. Check out the repository into your bundle path:
+
+        $ cd ~/.vim/bundle
+        $ git clone git://github.com/leafo/moonscript-vim.git
+
+### Normal
+
+1. Check out the repository and copy the following to `.vim/` directory or any
+   other run time path, keeping their directory structure intact:
+
+       syntax/moon.vim
+       indent/moon.vim
+       ftdetect/moon.vim
+
+## Thanks
+
+Special thanks to the <https://github.com/kchmck/vim-coffee-script> project. I
+copied the syntax and indent code as a starting point.