Updated readme with a lot more info, updated changelog, bumping verison v0.1.1

Author: ryanoasis

changelog.md

@@ -0,0 +1,4 @@
+- v0.1.1
+-- updated readme substantially
+- v0.1.0
+-- release

readme.md

@@ -1,24 +1,27 @@
 vim-webdevicons
-=============
+=================
 
-# Intro
+## Intro
 
 After seeing the awesome theme for Atom (set-ui) and the awesome plugins work done for NERDTree and vim-airline and wanting something like this for Vim I decided to create my first plugin.
 
 Adds a global config map of characters to file extensions (or entire filenames).
 
-Works best with the patched font provided (see lib folder), install font and add to your .gvimrc, e.g.:
+Works without Configuration *ONLY* when used with the patched font provided (see lib folder), install font and add to your vimrc or gvimrc, e.g.:
 > set guifont=Droid\ Sans\ Mono\ for\ Powerline\ Plus\ Nerd\ File\ Types\ 11
 
-# Screenshots
+* additional fonts coming soon
+* font patching coming soon
 
-![image](screenshots/vim-preview.png)
+## Screenshots
+
+![image](screenshots/vim.png)
 
 * NERDTree:
 
 ![image](screenshots/nerdtree.png)
 
-* Airline
+* vim-airline
 
 >> statusline
 
@@ -28,20 +31,84 @@ Works best with the patched font provided (see lib folder), install font and add
 
 >>> ![image](screenshots/airline-tabline.png)
 
-# Features
-
-# Configuration
-
-# todo
+## Features
+* show developer file type glyphs from a font in various vim plugins, currently supports:
+  * [NERDTree](https://github.com/scrooloose/nerdtree)
+  * [vim-airline](https://github.com/bling/vim-airline) (statusline and tabline)
+* customizable and extendable filetype detections
+  * ability to override predefined dictionary variable
+  * if you are unhappy with the default glpyh used you can choose your own
+* supports a range of file type extensions by default:
+  * styl, scss, htm, html, css, less, md, json, js, rb, php, py , coffee ,mustache, hbs, conf, ini, yml, jpg, jpeg, bmp, png, gif, ai
+
+## Configuration
+
+* by default you should not *NEED* to configure anything to get the basics working
+  * _NOTE:_ For the time being you do *NEED* the patched font provided _unless_ you want to configure the filetype to glyph mappings yourself for your current font
+* these options can be defined in your vimrc or gvimrc
+* the following options are provided however for overriding
+
+* enable/disable loading the plugin (default 1)
+>	let g:webdevicons_enable = 1
+* enable/disable adding the flags to NERDTree (default 1)
+>	let g:webdevicons_enable_nerdtree = 1
+* enable/disable adding to vim-airline's tabline (default 1)
+>	let g:webdevicons_enable_airline_tabline = 1
+* enable/disable adding to vim-airline's statusline (default 1)
+>	let g:webdevicons_enable_airline_statusline = 1
+
+* character mappings
+
+* turn on/off file node glpyh decorations (not particularly useful)
+>	let g:WebDevIconsUnicodeDecorateFileNodes = 1
+* change the default character when no match found
+>	let g:WebDevIconsUnicodeDecorateFileNodesDefaultSymbol = 'x'
+* change the default dictionary mappings for file extension matches
+>	let g:WebDevIconsUnicodeDecorateFileNodesExtensionSymbols = { 'js': 'mycoolJSfontglyph' }
+* change the default dictionary mappings for exact file node matches
+>	let g:WebDevIconsUnicodeDecorateFileNodesExactSymbols = { 'MyReallyCoolFile.okay': 'myreallycoolglyph' }
+
+## todo
 
+* more filetypes to support
+* make sure it works properly and does not conflict with [nerdtree-git-plugin](https://github.com/Xuyuanp/nerdtree-git-plugin)
 * customize filetype icon colors
 * more customization options in general
-* more filetypes to support
-
-# FAQ
-
-@todo
-
-# License
 
-@todo
+## FAQ / Troubleshooting
+
+* I don't want to use font XYZ, I want to use font ABC
+ * font patching is coming soon
+
+* It isn't working
+  * Are you using the patched font provided?
+    * Support for other fonts will come when patching is working
+  * _NOTE:_ if running vim and no font set it will default to the termianl font that is set
+  * check what the vim/gvim font is set to, from ex mode:
+>	:set guifont?
+  * check if the plugin is loaded (should give '1'), from ex mode:
+>	:echo loaded_webdevicons
+  * check if the plugin is enabled (should give '1'), from ex mode:
+>	:echo g:webdevicons_enable
+  * check if the plugin is enabled for NERDTree (should give '1'), from ex mode:
+    * this should *NOT* need to be set under normal circumstances
+>	:echo g:webdevicons_enable_nerdtree
+  * check if you are able to see the characters, from ex mode:
+>	:echo g:WebDevIconsUnicodeDecorateFileNodesDefaultSymbol
+  * if all this looks correct you may try this to see if any files show flags
+    * last resort, see if you can even set the default symbol and have it display anywhere (NERDTree, vim-airline's statusline, vim-airlines's tabline), from ex mode:
+>	:let g:WebDevIconsUnicodeDecorateFileNodesDefaultSymbol='x'
+
+* @todo: more specific FAQ and Troubleshooting help
+
+## Inspiration and special thanks
+
+* [vim-airline](https://github.com/bling/vim-airline)
+* [nerdtree](https://github.com/scrooloose/nerdtree)
+* [nerdtree-git-plugin](https://github.com/Xuyuanp/nerdtree-git-plugin)
+* [seti-ui](https://atom.io/themes/seti-ui)
+* [Steve Losh](http://learnvimscriptthehardway.stevelosh.com/)
+
+## License
+
+see [LICENSE](LICENSE)