+
+### Omnifunc
+
+The Nit plugin also defines an omnifunc which uses metadata files produced by nitpick which
+is called by syntastic.
+It is activated by default when editing a Nit source file, launch it using `ctrl-x ctrl-o`.
+It will suggest entities names from the current context and display the corresponding documentation.
+Once the correct completion has been selected, you can close the documentation preview window with `:pc`.
+
+The omnifunc applies a simple heuristic to recognize what kind of entities to display:
+(This is a simplification some behaviors are missing.)
+
+* If the cursor follows `import`, it will list known modules.
+* If it follows `new`, `super` or `class` it will list known classes.
+* If it follows a `.`, it will list properties.
+* If on an extern method declaration, it will list classes and properties.
+* Otherwise, it will list keywords and properties.
+
+Make sure to save your Nit module if using syntastic or to manually call nitpick the generate
+the metadata files before using the omnifunc. If there is no locally available metadata, it
+will use general metadata in the plugin directory.
+
+The metadata files from nitpick are stored in `~/.vim/nit/`. This location can be customized with
+the environment variable `NIT_VIM_DIR`.